ListItem.Value Property
Definition
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.
Gets or sets the value associated with the ListItem.
public:
property System::String ^ Value { System::String ^ get(); void set(System::String ^ value); };
public string Value { get; set; }
member this.Value : string with get, set
Public Property Value As String
Property Value
The value associated with the ListItem. The default is Empty.
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 the Value property to specify or determine the value associated with the ListItem.
Note
If the Value property contains null
, the get
accessor returns the value of the Text property. If the Text property, in turn, contains null
, String.Empty is returned.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see LocalizableAttribute and Globalization and Localization.
Applies to
See also
- Text
- ListControl
- RadioButtonList
- ListBox
- DropDownList
- CheckBoxList
- ListBox Web Server Control Overview
- RadioButton and RadioButtonList Web Server Controls Overview
- CheckBox and CheckBoxList Web Server Controls Overview
- BulletedList Web Server Control Overview
- DropDownList Web Server Control Overview