ASP.NET ListItem Control


Web Server Controls Web Server Controls

Definition and Usage

The ListItem control creates an item in a list.

This control is used with the list controls such as <asp:ListBox>, <asp:RadioButtonList> and <asp:BulletedList>.


Syntax

<asp:ListItem
Enabled="True|False"
Selected="True|False"
Text="label"
Value="value" />

Properties

Property Description .NET
Attributes Optional. A collection of attribute name and value pairs for the ListItem that are not directly supported by the class 1.0
Enabled Optional. Specifies if the item is enabled or disabled 2.0
Selected Optional. Specifies whether or not the item is selected 1.0
Text Optional. The text displayed in the ListItem 1.0
Value Optional. The value of the the ListItem. 1.0

Web Control Standard Properties

AccessKey, Attributes, BackColor, BorderColor, BorderStyle, BorderWidth, CssClass, Enabled, Font, EnableTheming, ForeColor, Height, IsEnabled, SkinID, Style, TabIndex, ToolTip, Width

For a full description, go to Web Control Standard Attributes.

Control Standard Properties

AppRelativeTemplateSourceDirectory, BindingContainer, ClientID, Controls, EnableTheming, EnableViewState, ID, NamingContainer, Page, Parent, Site, TemplateControl, TemplateSourceDirectory, UniqueID, Visible

For a full description, go to Control Standard Attributes.

It is possible to use the Text or Value properties and the inner HTML text to set the text displayed for an item in the list.

Example

<asp:ListItem Value="Text1" Text="Text2">Text3</asp:ListItem>

Depending on the combination of the three, different texts are shown and values used. The table below shows all possible combinations and their results:

Inner HTML Text Property Value Property Text Shown Value Used
Set Set Set Inner HTML Value Property
Set Set Not set Inner HTML Inner HTML
Set Not set Set Inner HTML Value Property
Set Not set Not set Inner HTML Inner HTML
Not set Set Set Text Property Value Property
Not set Set Not set Text Property Text Property
Not set Not set Set Value Property Value Property
Not set Not set Not set Not set Not set


Tips and Notes

Note: The Text and Value properties have a default value of an empty string. Because of this it is possible to have empty list items.


Examples

Basic ListItem in BulletedList
A BulletedList control with two ListItems in an .aspx file.

ListItems with different properties in ListBox
A ListBox control with some ListItems in an .aspx file. The items in the list uses different properties to show the ListItem text.

ListItem disabled in ListBox
A ListBox control with one of the ListItems disabled.

ListItem selected in RadioButtonList
A RadioButtonList control with one of the ListItems selected.


Web Server Controls Web Server Controls

Color Picker

colorpicker