ListItem Constructor (String, String, Boolean)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Initializes a new instance of the ListItem class with the specified text, value, and enabled data.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public ListItem(
	string text,
	string value,
	bool enabled
)

Parameters

text
Type: System.String

The text to display in the list control for the item represented by the ListItem.

value
Type: System.String

The value associated with the ListItem.

enabled
Type: System.Boolean

Indicates whether the ListItem is enabled.

The following table shows initial property values for an instance of ListItem.

Property

Initial Value

Text

The value of the text parameter.

Value

The value of the value parameter.

Enabled

The value of the enabled parameter.

The following example demonstrates adding items to and removing items from ListBox controls. When an item is selected in the ListBox1 control, a new ListItem control with the same value can be created and added to the ListBox2 control, if the ListBox2 control does not already contain an item with that text. In this example the constructor is called with enabled set to true. If it was called with enabled set to false, the new ListItem control would not appear in the ListBox control.

System_CAPS_noteNote

The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see ASP.NET Web Forms Page Code Model.


<%@ Page Language="C#" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
 <head>
    <title>ListItem Example</title>
<script runat="server">

         void AddBtn_Click(Object Sender, EventArgs e) 
         {
             if (ListBox1.SelectedIndex > -1) 
             {
                  if (ListBox2.Items.FindByText(ListBox1.SelectedItem.Text) == null) 
                 {
                     ListItem Item = new ListItem(ListBox1.SelectedItem.Text, 
                         ListBox1.SelectedItem.Value, true);
                     ListBox2.Items.Add(Item);
                  }
             }
         }

         void DelBtn_Click(Object Sender, EventArgs e) 
         {
             if (ListBox2.SelectedIndex > -1) 
             {
                 ListBox2.Items.Remove(ListBox2.SelectedItem);
             }
         }

     </script>

 </head>
 <body>

     <h3>ListItem Example</h3>
     <form id="form1" runat="server">
     <table>
     <tr><td>
         <asp:ListBox id="ListBox1" Width="100px" runat="server">
             <asp:ListItem Value="Value 1">Item 1</asp:ListItem>
             <asp:ListItem Value="Value 2">Item 2</asp:ListItem>
             <asp:ListItem Value="Value 3">Item 3</asp:ListItem>
             <asp:ListItem Value="Value 4">Item 4</asp:ListItem>
             <asp:ListItem Value="Value 5" Selected="True">Item 5</asp:ListItem>
             <asp:ListItem Value="Value 6">Item 6</asp:ListItem>
         </asp:ListBox>
     </td><td>
         <asp:button Text="--->" OnClick="AddBtn_Click" runat="server" /><br />
         <asp:button Text="<---" OnClick="DelBtn_Click" runat="server" />
    </td><td>
         <asp:ListBox id="ListBox2" Width="100px" runat="server"/>
     </td></tr>
     </table>
     </form>

 </body>
 </html>

.NET Framework
Available since 2.0
Return to top
Show: