ListBox 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
表示允许单选或多选的列表框控件。
public ref class ListBox : System::Web::UI::WebControls::ListControl, System::Web::UI::IPostBackDataHandler[System.Web.UI.ValidationProperty("SelectedItem")]
public class ListBox : System.Web.UI.WebControls.ListControl, System.Web.UI.IPostBackDataHandler[<System.Web.UI.ValidationProperty("SelectedItem")>]
type ListBox = class
inherit ListControl
interface IPostBackDataHandlerPublic Class ListBox
Inherits ListControl
Implements IPostBackDataHandler- 继承
- 继承
- 属性
- 实现
示例
以下示例演示如何创建 ListBox 控件。
<%@ 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>ListBox Example</title>
<script language="C#" runat="server">
void SubmitBtn_Click(Object sender, EventArgs e)
{
if (ListBox1.SelectedIndex > -1)
Label1.Text="You chose: " + ListBox1.SelectedItem.Text;
}
</script>
</head>
<body>
<h3>ListBox Example</h3>
<form id="form1" runat="server">
<asp:ListBox id="ListBox1"
Rows="6"
Width="100px"
SelectionMode="Single"
runat="server">
<asp:ListItem>Item 1</asp:ListItem>
<asp:ListItem>Item 2</asp:ListItem>
<asp:ListItem>Item 3</asp:ListItem>
<asp:ListItem>Item 4</asp:ListItem>
<asp:ListItem>Item 5</asp:ListItem>
<asp:ListItem>Item 6</asp:ListItem>
</asp:ListBox>
<asp:button id="Button1"
Text="Submit"
OnClick="SubmitBtn_Click"
runat="server" />
<asp:Label id="Label1"
Font-Names="Verdana"
Font-Size="10pt"
runat="server"/>
</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>ListBox Example</title>
<script language="VB" runat="server">
Sub SubmitBtn_Click(sender As Object, e As EventArgs)
If ListBox1.SelectedIndex > - 1 Then
Label1.Text = "You chose: " & ListBox1.SelectedItem.Text
End If
End Sub 'SubmitBtn_Click
</script>
</head>
<body>
<h3>ListBox Example</h3>
<form id="form1" runat="server">
<asp:ListBox id="ListBox1"
Rows="6"
Width="100px"
SelectionMode="Single"
runat="server">
<asp:ListItem>Item 1</asp:ListItem>
<asp:ListItem>Item 2</asp:ListItem>
<asp:ListItem>Item 3</asp:ListItem>
<asp:ListItem>Item 4</asp:ListItem>
<asp:ListItem>Item 5</asp:ListItem>
<asp:ListItem>Item 6</asp:ListItem>
</asp:ListBox>
<asp:button id="Button1"
Text="Submit"
OnClick="SubmitBtn_Click"
runat="server" />
<asp:Label id="Label1"
Font-Names="Verdana"
Font-Size="10pt"
runat="server"/>
</form>
</body>
</html>
以下示例演示如何创建 ListBox 支持多个选择的控件。
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<script language="C#" runat="server">
void SubmitBtn_Click(Object sender, EventArgs e)
{
string msg = "";
foreach (ListItem li in ListBox1.Items)
{
if (li.Selected == true)
{
msg += "<BR>" + li.Text + " is selected.";
}
}
Label1.Text = msg;
}
</script>
</head>
<body>
<h3>ListBox Example</h3>
<form id="Form1" runat=server>
<asp:ListBox id="ListBox1"
Rows="6"
Width="100px"
SelectionMode="Multiple"
runat="server">
<asp:ListItem>Item 1</asp:ListItem>
<asp:ListItem>Item 2</asp:ListItem>
<asp:ListItem>Item 3</asp:ListItem>
<asp:ListItem>Item 4</asp:ListItem>
<asp:ListItem>Item 5</asp:ListItem>
<asp:ListItem>Item 6</asp:ListItem>
</asp:ListBox>
<asp:button id="Button1"
Text="Submit"
OnClick="SubmitBtn_Click"
runat="server" />
<asp:Label id="Label1"
Font-Name="Verdana"
Font-Size="10pt"
runat="server"/>
</form>
</body>
</html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<script language="VB" runat="server">
Sub SubmitBtn_Click(sender As Object, e As EventArgs)
Dim msg As String
Dim li As ListItem
msg = ""
For Each li In ListBox1.Items
If li.Selected = True Then
msg = msg & "<br>" & li.Text & " selected."
End If
Next
Label1.Text = msg
End Sub 'SubmitBtn_Click
</script>
</head>
<body>
<h3>ListBox Example</h3>
<form id="Form1" runat=server>
<asp:ListBox id="ListBox1"
Rows="6"
Width="100px"
SelectionMode="Multiple"
runat="server">
<asp:ListItem>Item 1</asp:ListItem>
<asp:ListItem>Item 2</asp:ListItem>
<asp:ListItem>Item 3</asp:ListItem>
<asp:ListItem>Item 4</asp:ListItem>
<asp:ListItem>Item 5</asp:ListItem>
<asp:ListItem>Item 6</asp:ListItem>
</asp:ListBox>
<asp:button id="Button1"
Text="Submit"
OnClick="SubmitBtn_Click"
runat="server" />
<asp:Label id="Label1"
Font-Name="Verdana"
Font-Size="10pt"
runat="server"/>
</form>
</body>
</html>
以下示例演示如何通过数据绑定创建 ListBox 控件。
<%@ 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>Data Binding ListBox</title>
<script language="C#" runat="server">
void Page_Load(Object sender, EventArgs e)
{
if (!IsPostBack)
{
ArrayList values = new ArrayList();
values.Add ("Item 1");
values.Add ("Item 2");
values.Add ("Item 3");
values.Add ("Item 4");
values.Add ("Item 5");
values.Add ("Item 6");
ListBox1.DataSource = values;
ListBox1.DataBind();
}
}
void SubmitBtn_Click(Object sender, EventArgs e)
{
if ( ListBox1.SelectedIndex > -1 )
Label1.Text = "You chose: " + ListBox1.SelectedItem.Text;
}
</script>
</head>
<body>
<form id="form1" runat="server">
<h3>Data Binding ListBox</h3>
<asp:ListBox id="ListBox1"
Width="100px"
runat="server"/>
<asp:button id="Button1"
Text="Submit"
OnClick="SubmitBtn_Click"
runat="server" />
<asp:Label id="Label1"
Font-Names="Verdana"
font-size="10pt"
runat="server"/>
</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>Data Binding ListBox</title>
<script language="VB" runat="server">
Sub Page_Load(sender As Object, e As EventArgs)
If Not IsPostBack Then
Dim values As New ArrayList()
values.Add("Item 1")
values.Add("Item 2")
values.Add("Item 3")
values.Add("Item 4")
values.Add("Item 5")
values.Add("Item 6")
ListBox1.DataSource = values
ListBox1.DataBind()
End If
End Sub 'Page_Load
Sub SubmitBtn_Click(sender As Object, e As EventArgs)
If ListBox1.SelectedIndex > - 1 Then
Label1.Text = "You chose: " & ListBox1.SelectedItem.Text
End If
End Sub 'SubmitBtn_Click
</script>
</head>
<body>
<form id="form1" runat="server">
<h3>Data Binding ListBox</h3>
<asp:ListBox id="ListBox1"
Width="100px"
runat="server"/>
<asp:button id="Button1"
Text="Submit"
OnClick="SubmitBtn_Click"
runat="server" />
<asp:Label id="Label1"
Font-Names="Verdana"
font-size="10pt"
runat="server"/>
</form>
</body>
</html>
注解
本主题内容：
介绍
使用 控件 ListBox 创建允许选择一个或多个项的列表控件。
Rows使用 属性指定控件的高度。 若要启用多个项选择，请将 SelectionMode 属性设置为 ListSelectionMode.Multiple。
若要指定要显示在控件中的ListBox项，请在控件的开始和结束标记ListBox之间为每个条目放置一个ListItem元素。
Items使用 集合检查ListItem控件中包含的ListBox对象。 例如，可以通过枚举Items集合并测试Selected每个ListItem元素的值来确定控件中 ListBox () 的选定项。
控件 ListBox 还支持数据绑定。 若要将控件绑定到数据源，请首先创建一个数据源（如对象之 DataSourceControl 一），其中包含要显示在控件中的项。 接下来，使用 DataBind 方法将数据源绑定到 ListBox 控件。
DataTextField使用 和 DataValueField 属性可指定要分别绑定到Text控件中每个列表项的 和 Value 属性的数据源中的哪个字段。 控件 ListBox 现在将显示数据源中的信息。
注意
此控件可用于显示用户输入，其中可能包括恶意客户端脚本。 在应用程序中显示之前，请检查从客户端发送的任何信息，以获取可执行脚本、SQL 语句或其他代码。 在控件中显示输入文本之前，可以使用验证控件来验证用户输入。 ASP.NET 提供输入请求验证功能，以阻止用户输入中的脚本和 HTML。 有关详细信息，请参阅 保护标准控件、 如何：通过对字符串应用 HTML 编码在 Web 应用程序中防止脚本攻击和 验证 ASP.NET 网页中的用户输入。
可访问性
有关如何配置此控件以便生成符合辅助功能标准的标记的信息，请参阅 Visual Studio 中的辅助功能和 ASP.NET 和 ASP.NET 控件和辅助功能。
声明性语法
<asp:ListBox
AccessKey="string"
AppendDataBoundItems="True|False"
AutoPostBack="True|False"
BackColor="color name|#dddddd"
BorderColor="color name|#dddddd"
BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
Inset|Outset"
BorderWidth="size"
CausesValidation="True|False"
CssClass="string"
DataMember="string"
DataSource="string"
DataSourceID="string"
DataTextField="string"
DataTextFormatString="string"
DataValueField="string"
Enabled="True|False"
EnableTheming="True|False"
EnableViewState="True|False"
Font-Bold="True|False"
Font-Italic="True|False"
Font-Names="string"
Font-Overline="True|False"
Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
Large|X-Large|XX-Large"
Font-Strikeout="True|False"
Font-Underline="True|False"
ForeColor="color name|#dddddd"
Height="size"
ID="string"
OnDataBinding="DataBinding event handler"
OnDataBound="DataBound event handler"
OnDisposed="Disposed event handler"
OnInit="Init event handler"
OnLoad="Load event handler"
OnPreRender="PreRender event handler"
OnSelectedIndexChanged="SelectedIndexChanged event handler"
OnTextChanged="TextChanged event handler"
OnUnload="Unload event handler"
Rows="integer"
runat="server"
SelectedIndex="integer"
SelectedValue="string"
SelectionMode="Single|Multiple"
SkinID="string"
Style="string"
TabIndex="integer"
ToolTip="string"
ValidationGroup="string"
Visible="True|False"
Width="size"
>
<asp:ListItem
Enabled="True|False"
Selected="True|False"
Text="string"
Value="string"
/>
</asp:ListBox>
构造函数
| ListBox() |
初始化 ListBox 类的新实例。 |
属性
| AccessKey |
获取或设置使您得以快速导航到 Web 服务器控件的访问键。 (继承自 WebControl) |
| Adapter |
获取控件的浏览器特定适配器。 (继承自 Control) |
| AppendDataBoundItems |
获取或设置指示是否在绑定数据之前清除列表项的值。 (继承自 ListControl) |
| AppRelativeTemplateSourceDirectory |
获取或设置包含该控件的 Page 或 UserControl 对象的应用程序相对虚拟目录。 (继承自 Control) |
| Attributes |
获取与控件的特性不对应的任意特性（只用于呈现）的集合。 (继承自 WebControl) |
| AutoPostBack |
获取或设置一个值，该值指示当用户更改列表中的选定内容时是否自动产生向服务器的回发。 (继承自 ListControl) |
| BackColor |
获取或设置 Web 服务器控件的背景色。 (继承自 WebControl) |
| BindingContainer |
获取包含该控件的数据绑定的控件。 (继承自 Control) |
| BorderColor |
获取或设置控件的边框颜色。 |
| BorderStyle |
获取或设置控件的边框样式。 |
| BorderWidth |
获取或设置控件的边框宽度。 |
| CausesValidation |
获取或设置指示在单击从 ListControl 类派生的控件时是否执行验证的值。 (继承自 ListControl) |
| ChildControlsCreated |
获取一个值，该值指示是否已创建服务器控件的子控件。 (继承自 Control) |
| ClientID |
获取由 ASP.NET 生成的 HTML 标记的控件 ID。 (继承自 Control) |
| ClientIDMode |
获取或设置用于生成 ClientID 属性值的算法。 (继承自 Control) |
| ClientIDSeparator |
获取一个字符值，该值表示 ClientID 属性中使用的分隔符字符。 (继承自 Control) |
| Context |
为当前 Web 请求获取与服务器控件关联的 HttpContext 对象。 (继承自 Control) |
| Controls |
获取 ControlCollection 对象，该对象表示 UI 层次结构中的指定服务器控件的子控件。 (继承自 Control) |
| ControlStyle |
获取 Web 服务器控件的样式。 此属性主要由控件开发人员使用。 (继承自 WebControl) |
| ControlStyleCreated |
获取一个值，该值指示是否已为 Style 属性创建了 ControlStyle 对象。 此属性主要由控件开发人员使用。 (继承自 WebControl) |
| CssClass |
获取或设置由 Web 服务器控件在客户端呈现的级联样式表 (CSS) 类。 (继承自 WebControl) |
| DataItemContainer |
如果命名容器实现 IDataItemContainer，则获取对命名容器的引用。 (继承自 Control) |
| DataKeysContainer |
如果命名容器实现 IDataKeysControl，则获取对命名容器的引用。 (继承自 Control) |
| DataMember |
获取或设置 DataSource 中要绑定到控件的特定表。 (继承自 ListControl) |
| DataSource |
获取或设置填充列表控件项的数据源。 (继承自 ListControl) |
| DataSourceID |
获取或设置控件的 ID，数据绑定控件从该控件中检索其数据项列表。 (继承自 DataBoundControl) |
| DataSourceObject |
获取一个对象，该对象实现 IDataSource 接口，以便提供对该对象的数据内容的访问。 (继承自 DataBoundControl) |
| DataTextField |
获取或设置为列表项提供文本内容的数据源字段。 (继承自 ListControl) |
| DataTextFormatString |
获取或设置格式化字符串，该字符串用来控制如何显示绑定到列表控件的数据。 (继承自 ListControl) |
| DataValueField |
获取或设置为各列表项提供值的数据源字段。 (继承自 ListControl) |
| DesignMode |
获取一个值，该值指示是否正在使用设计图面上的一个控件。 (继承自 Control) |
| Enabled |
获取或设置一个值，该值指示是否启用 Web 服务器控件。 (继承自 WebControl) |
| EnableTheming |
获取或设置一个值，该值指示主题是否应用于该控件。 (继承自 WebControl) |
| EnableViewState |
获取或设置一个值，该值指示服务器控件是否向发出请求的客户端保持自己的视图状态以及它所包含的任何子控件的视图状态。 (继承自 Control) |
| Events |
获取控件的事件处理程序委托列表。 此属性为只读。 (继承自 Control) |
| Font |
获取与 Web 服务器控件关联的字体属性。 (继承自 WebControl) |
| ForeColor |
获取或设置 Web 服务器控件的前景色（通常是文本颜色）。 (继承自 WebControl) |
| HasAttributes |
获取一个值，该值指示控件是否具有特性集。 (继承自 WebControl) |
| HasChildViewState |
获取一个值，该值指示当前服务器控件的子控件是否具有任何已保存的视图状态设置。 (继承自 Control) |
| Height |
获取或设置 Web 服务器控件的高度。 (继承自 WebControl) |
| ID |
获取或设置分配给服务器控件的编程标识符。 (继承自 Control) |
| IdSeparator |
获取用于分隔控件标识符的字符。 (继承自 Control) |
| Initialized |
获取一个值，该值指示数据绑定控件是否已经初始化。 (继承自 BaseDataBoundControl) |
| IsBoundUsingDataSourceID |
获取指示是否设置 DataSourceID 属性的值。 (继承自 BaseDataBoundControl) |
| IsChildControlStateCleared |
获取一个值，该值指示该控件中包含的控件是否具有控件状态。 (继承自 Control) |
| IsDataBindingAutomatic |
获取一个值，该值指示数据绑定是否自动进行。 (继承自 BaseDataBoundControl) |
| IsEnabled |
获取一个值，该值指示是否启用控件。 (继承自 WebControl) |
| IsTrackingViewState |
获取一个值，用于指示服务器控件是否会将更改保存到其视图状态中。 (继承自 Control) |
| IsUsingModelBinders |
获取一个值，该值指示是否使用模型绑定。 (继承自 DataBoundControl) |
| IsViewStateEnabled |
获取一个值，该值指示是否为该控件启用了视图状态。 (继承自 Control) |
| Items |
获取列表控件项的集合。 (继承自 ListControl) |
| ItemType |
获取或设置强类型化数据绑定的数据项目类型的名称。 (继承自 DataBoundControl) |
| LoadViewStateByID |
获取一个值，该值指示控件是否通过 ID 而不是索引参与加载其视图状态。 (继承自 Control) |
| NamingContainer |
获取对服务器控件的命名容器的引用，此引用创建唯一的命名空间，以区分具有相同 ID 属性值的服务器控件。 (继承自 Control) |
| Page |
获取对包含服务器控件的 Page 实例的引用。 (继承自 Control) |
| Parent |
获取对页 UI 层次结构中服务器控件的父控件的引用。 (继承自 Control) |
| RenderingCompatibility |
获取一个值，该值指定呈现的 HTML 将与之兼容的 ASP.NET 版本。 (继承自 Control) |
| RequiresDataBinding |
获取或设置一个值，该值指示是否应调用 DataBind() 方法。 (继承自 BaseDataBoundControl) |
| Rows |
获取或设置 ListBox 控件中显示的行数。 |
| SelectArguments |
获取数据绑定控件从数据源控件检索数据时使用的 DataSourceSelectArguments 对象。 (继承自 DataBoundControl) |
| SelectedIndex |
获取或设置列表中选定项的最低序号索引。 (继承自 ListControl) |
| SelectedItem |
获取列表控件中索引最小的选定项。 (继承自 ListControl) |
| SelectedValue |
获取列表控件中选定项的值，或选择列表控件中包含指定值的项。 (继承自 ListControl) |
| SelectionMode |
获取或设置 ListBox 控件的选择模式。 |
| SelectMethod |
为了读取数据要调用的方法的名称。 (继承自 DataBoundControl) |
| Site |
获取容器信息，该容器在呈现于设计图面上时承载当前控件。 (继承自 Control) |
| SkinID |
获取或设置要应用于控件的外观。 (继承自 WebControl) |
| Style |
获取将在 Web 服务器控件的外部标记上呈现为样式特性的文本特性的集合。 (继承自 WebControl) |
| SupportsDisabledAttribute |
获取一个值，该值指示在控件的 |
| SupportsDisabledAttribute |
获取一个值，该值指示在控件的 |
| TabIndex |
获取或设置 Web 服务器控件的选项卡索引。 (继承自 WebControl) |
| TagKey |
获取 ListControl 控件的 HtmlTextWriterTag 值。 (继承自 ListControl) |
| TagName |
获取控件标记的名称。 此属性主要由控件开发人员使用。 (继承自 WebControl) |
| TemplateControl |
获取或设置对包含该控件的模板的引用。 (继承自 Control) |
| TemplateSourceDirectory |
获取包含当前服务器控件的 Page 或 UserControl 的虚拟目录。 (继承自 Control) |
| Text |
获取或设置 ListControl 控件的 SelectedValue 属性。 (继承自 ListControl) |
| ToolTip |
获取或设置当鼠标指针停留在控件上时所显示的工具提示文本。 |
| ToolTip |
获取或设置当鼠标指针悬停在 Web 服务器控件上时显示的文本。 (继承自 WebControl) |
| UniqueID |
获取服务器控件的唯一的、以分层形式限定的标识符。 (继承自 Control) |
| ValidateRequestMode |
获取或设置指示控件是否检查来自浏览器的客户端输入是否具有潜在危险值的值。 (继承自 Control) |
| ValidationGroup |
获取或设置控件组，当从 ListControl 类派生的控件回发到服务器时，将引发对该控件组的验证。 (继承自 ListControl) |
| ViewState |
获取状态信息的字典，这些信息使您可以在同一页的多个请求间保存和还原服务器控件的视图状态。 (继承自 Control) |
| ViewStateIgnoresCase |
获取一个值，该值指示 StateBag 对象是否不区分大小写。 (继承自 Control) |
| ViewStateMode |
获取或设置此控件的视图状态模式。 (继承自 Control) |
| Visible |
获取或设置一个值，该值指示服务器控件是否作为 UI 呈现在页上。 (继承自 Control) |
| Width |
获取或设置 Web 服务器控件的宽度。 (继承自 WebControl) |
方法
事件
| CallingDataMethods |
在数据方法正被调用时发生。 (继承自 DataBoundControl) |
| CreatingModelDataSource |
当 ModelDataSource 对象正被创建时发生。 (继承自 DataBoundControl) |
| DataBinding |
当服务器控件绑定到数据源时发生。 (继承自 Control) |
| DataBound |
在服务器控件绑定到数据源后发生。 (继承自 BaseDataBoundControl) |
| Disposed |
当从内存释放服务器控件时发生，这是请求 ASP.NET 页时服务器控件生存期的最后阶段。 (继承自 Control) |
| Init |
当服务器控件初始化时发生；初始化是控件生存期的第一步。 (继承自 Control) |
| Load |
当服务器控件加载到 Page 对象中时发生。 (继承自 Control) |
| PreRender |
在加载 Control 对象之后、呈现之前发生。 (继承自 Control) |
| SelectedIndexChanged |
当列表控件的选定项在信息发往服务器之间变化时发生。 (继承自 ListControl) |
| TextChanged |
当 Text 和 SelectedValue 属性更改时发生。 (继承自 ListControl) |
| Unload |
当服务器控件从内存中卸载时发生。 (继承自 Control) |
显式接口实现
扩展方法
| EnablePersistedSelection(BaseDataBoundControl) |
已过时.
使选定内容能够保留在支持选择和分页的数据控件中。 |
| FindDataSourceControl(Control) |
返回与指定控件的数据控件关联的数据源。 |
| FindFieldTemplate(Control, String) |
返回指定控件的命名容器中指定列的字段模板。 |
| FindMetaTable(Control) |
返回包含数据控件的元表对象。 |
