ListItem Constructors

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Initializes a new instance of the ListItem class.

Overloads

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

ListItem()

Initializes a new instance of the ListItem class.

public:
 ListItem();

public ListItem ();

Public Sub New ()

Examples

Note

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.

<!-- The following example demonstrates adding items to and removing items
from ListBox controls. When an item is selected in ListBox1, a new ListBoxItem with
the same value can be created and added to ListBox2, if ListBox2 does not already 
contain an item with that value. When the new ListBoxItem is created, it receives 
the Value property of the selected item as its Text property, and the Text property
of the selected item as its value property. -->

<%@ 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.FindByValue(ListBox1.SelectedItem.Text) == null) 
                 {
                      ListItem Item = new ListItem();
                      // Text and Value are swapped.
                     Item.Text = ListBox1.SelectedItem.Value;
                     Item.Value = ListBox1.SelectedItem.Text;
                     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>

<%@ Page Language="VB" %>
<!-- The following example demonstrates adding items to and removing items
from ListBox controls. When an item is selected in ListBox1, a new ListBoxItem with
the same value can be created and added to ListBox2, if ListBox2 does not already 
contain an item with that value. When the new ListBoxItem is created, it receives 
the Value property of the selected item as its Text property, and the Text property
of the selected item as its value property. -->

<!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 language="VB" runat="server">
 
         Sub AddBtn_Click(Sender As Object, e As EventArgs)
             If ListBox1.SelectedIndex > -1 Then
                  If ListBox2.Items.FindByValue(ListBox1.SelectedItem.Text) is Nothing Then
                      Dim Item As ListItem = new ListItem()
                      'Text and Value are swapped
                     Item.Text = ListBox1.SelectedItem.Value
                     Item.Value = ListBox1.SelectedItem.Text
                     ListBox2.Items.Add(Item)
                  End If
             End If
         End Sub
 
         Sub DelBtn_Click(Sender As Object, e As EventArgs)
             If ListBox2.SelectedIndex > -1 Then
                 ListBox2.Items.Remove(ListBox2.SelectedItem)
             End If
         End Sub
 
     </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>

Remarks

Use this constructor to create and initialize a new instance of the ListItem class using default values.

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

Property	Initial Value
`Text`	`null`
`Value`	`null`
`Enabled`	`true`

Applies to

ListItem(String)

Initializes a new instance of the ListItem class with the specified text data.

public:
 ListItem(System::String ^ text);

public ListItem (string text);

new System.Web.UI.WebControls.ListItem : string -> System.Web.UI.WebControls.ListItem

Public Sub New (text As String)

Parameters

text: String

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

Examples

Note

<!-- The following example demonstrates adding items to and removing items
from ListBox controls. When an item is selected in ListBox1, a new ListBoxItem with
the same value can be created and added to ListBox2, if ListBox2 does not already 
contain an item with that text. -->

<%@ 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);
                     Item.Value = ListBox1.SelectedItem.Value;
                     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>

<!-- The following example demonstrates adding items to and removing items
from ListBox controls. When an item is selected in ListBox1, a new ListBoxItem with
the same value can be created and added to ListBox2, if ListBox2 does not already 
contain an item with that text. -->

<%@ Page Language="VB" 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">
 
         Sub AddBtn_Click(Sender As Object, e As EventArgs)
             If ListBox1.SelectedIndex > -1 Then
                  If ListBox2.Items.FindByText(ListBox1.SelectedItem.Text) is Nothing Then
                      Dim Item As ListItem = new ListItem(ListBox1.SelectedItem.Text)
                     Item.Value = ListBox1.SelectedItem.Value
                     ListBox2.Items.Add(Item)
                  End If
             End If
         End Sub
 
         Sub DelBtn_Click(Sender As Object, e As EventArgs)
             If ListBox2.SelectedIndex > -1 Then
                 ListBox2.Items.Remove(ListBox2.SelectedItem)
             End If
         End Sub
 
     </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>

Remarks

Use this constructor to create and initialize a new instance of the ListItem class using the specified text.

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

Property	Initial Value
`Text`	The value of the `text` parameter.
`Value`	`null`
`Enabled`	`true`

Applies to

ListItem(String, String)

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

public:
 ListItem(System::String ^ text, System::String ^ value);

public ListItem (string text, string value);

new System.Web.UI.WebControls.ListItem : string * string -> System.Web.UI.WebControls.ListItem

Public Sub New (text As String, value As String)

Parameters

text: String

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

value: String

The value associated with the ListItem.

Examples

Note

<!-- The following example demonstrates adding items to and removing items
from ListBox controls. When an item is selected in ListBox1, a new ListBoxItem with
the same value can be created and added to ListBox2, if ListBox2 does not already 
contain an item with that text. -->

<%@ 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);
                     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>

<!-- The following example demonstrates adding items to and removing items
from ListBox controls. When an item is selected in ListBox1, a new ListBoxItem with
the same value can be created and added to ListBox2, if ListBox2 does not already 
contain an item with that text. -->

<%@ Page Language="VB" 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">
 
         Sub AddBtn_Click(Sender As Object, e As EventArgs)
             If ListBox1.SelectedIndex > -1 Then
                  If ListBox2.Items.FindByText(ListBox1.SelectedItem.Text) is Nothing Then
                      Dim Item As ListItem = new ListItem(ListBox1.SelectedItem.Text, _
                            ListBox1.SelectedItem.Value)
                     ListBox2.Items.Add(Item)
                  End If
             End If
         End Sub
 
         Sub DelBtn_Click(Sender As Object, e As EventArgs)
             If ListBox2.SelectedIndex > -1 Then
                 ListBox2.Items.Remove(ListBox2.SelectedItem)
             End If
         End Sub
 
     </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>

Remarks

Use this constructor to create and initialize a new instance of the ListItem class using the specified text and value.

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`	`true`

Applies to

ListItem(String, String, Boolean)

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

public:
 ListItem(System::String ^ text, System::String ^ value, bool enabled);

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

new System.Web.UI.WebControls.ListItem : string * string * bool -> System.Web.UI.WebControls.ListItem

Public Sub New (text As String, value As String, enabled As Boolean)

Parameters

text: String

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

value: String

The value associated with the ListItem.

enabled: Boolean

Indicates whether the ListItem is enabled.

Examples

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.

Note


<%@ 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>


<%@ Page Language="VB" 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">
 
         Sub AddBtn_Click(Sender As Object, e As EventArgs)
             If ListBox1.SelectedIndex > -1 Then
                  If ListBox2.Items.FindByText(ListBox1.SelectedItem.Text) is Nothing Then
             Dim Item As ListItem = New ListItem(ListBox1.SelectedItem.Text, _
                         ListBox1.SelectedItem.Value, True)
                     ListBox2.Items.Add(Item)
                  End If
             End If
         End Sub
 
         Sub DelBtn_Click(Sender As Object, e As EventArgs)
             If ListBox2.SelectedIndex > -1 Then
                 ListBox2.Items.Remove(ListBox2.SelectedItem)
             End If
         End Sub
 
     </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>

Remarks

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.

Applies to

ListItem Constructors

Definition

Overloads

ListItem()

Examples

Remarks

See also

Applies to

ListItem(String)

Parameters

Examples

Remarks

See also

Applies to

ListItem(String, String)

Parameters

Examples

Remarks

See also

Applies to

ListItem(String, String, Boolean)

Parameters

Examples

Remarks

See also

Applies to

Feedback

Additional resources