ListControl 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
用作定义所有列表类型控件通用的属性、方法和事件的抽象基类。
public ref class ListControl abstract : System::Web::UI::WebControls::WebControlpublic ref class ListControl abstract : System::Web::UI::WebControls::DataBoundControl, System::Web::UI::IEditableTextControlpublic abstract class ListControl : System.Web.UI.WebControls.WebControl[System.Web.UI.ControlValueProperty("SelectedValue")]
public abstract class ListControl : System.Web.UI.WebControls.DataBoundControl, System.Web.UI.IEditableTextControltype ListControl = class
inherit WebControl[<System.Web.UI.ControlValueProperty("SelectedValue")>]
type ListControl = class
inherit DataBoundControl
interface IEditableTextControl
interface ITextControlPublic MustInherit Class ListControl
Inherits WebControlPublic MustInherit Class ListControl
Inherits DataBoundControl
Implements IEditableTextControl- 继承
- 继承
- 派生
- 属性
- 实现
示例
下面的代码示例演示如何选择 控件中的 ListBox 项。 如果在文本框中找到该项，则会选择该项，并显示一条消息，指出所选项目的名称。 如果未找到该项，则未选择任何项目，并显示一条消息，指出未找到该项目。
重要
此示例具有一个接受用户输入的文本框，这是一个潜在的安全威胁。 默认情况下，ASP.NET 网页验证用户输入是否不包含脚本或 HTML 元素。 有关详细信息，请参阅脚本侵入概述。
<%@ 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 runat="server">
<title> ListControl SelectedValue Example </title>
<script runat="server">
void Button_Click(Object sender, EventArgs e)
{
// Perform this operation in a try-catch block in case the item is not found.
try
{
List.SelectedValue = ItemTextBox.Text;
MessageLabel.Text = "You selected " + List.SelectedValue + ".";
}
catch (Exception ex)
{
List.SelectedValue = null;
MessageLabel.Text = "Item not found in ListBox control.";
}
}
</script>
</head>
<body>
<form id="form1" runat="server">
<h3> ListControl SelectedValue Example </h3>
<asp:ListBox ID="List"
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:ListBox>
<hr />
Enter the value of the item to select: <br />
<asp:TextBox ID="ItemTextBox"
MaxLength="6"
Text="Item 1"
runat="server"/>
<asp:Button ID="SelectButton"
Text="Select Item"
OnClick="Button_Click"
runat="server"/>
<br /><br />
<asp:Label ID="MessageLabel"
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 runat="server">
<title> ListControl SelectedValue Example </title>
<script runat="server">
Sub Button_Click(sender As Object, e As EventArgs)
' Perform this operation in a try-catch block in case the item is not found.
Try
List.SelectedValue = ItemTextBox.Text
MessageLabel.Text = "You selected " & List.SelectedValue + "."
Catch ex As Exception
List.SelectedValue = Nothing
MessageLabel.Text = "Item not found in ListBox control."
End Try
End Sub
</script>
</head>
<body>
<form id="form1" runat="server">
<h3> ListControl SelectedValue Example </h3>
<asp:ListBox ID="List"
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:ListBox>
<hr />
Enter the value of the item to select: <br />
<asp:TextBox ID="ItemTextBox"
MaxLength="6"
Text="Item 1"
runat="server"/>
<asp:Button ID="SelectButton"
Text="Select Item"
OnClick="Button_Click"
runat="server"/>
<br /><br />
<asp:Label ID="MessageLabel"
runat="server"/>
</form>
</body>
</html>
注解
不能直接创建抽象类的 ListControl 实例。 相反，此类由其他类（如 CheckBoxList、 DropDownList、 ListBox和 RadioButtonList 类）继承，以提供常见的基本功能。
类的属性 ListControl 允许您指定用于填充列表控件的数据源。 DataSource使用 属性指定要绑定到列表控件的数据源。 如果数据源包含多个表，请使用 DataMember 属性指定要使用的表。 可以通过分别设置 DataTextField 和 ListItem.Value 属性，将数据源中的不同字段绑定到ListItem.Text列表控件中项的 和 DataValueField 属性。 列表控件中每个项显示的文本可以通过设置 DataTextFormatString 属性来设置格式。
列表控件中显示的所有项都存储在 集合中 Items 。 可以使用 属性以编程方式指定或确定列表控件中选定项的 SelectedIndex 索引。 可以使用 属性访问所选项的属性 SelectedItem 。
类 ListControl 提供 SelectedIndexChanged 事件，当列表控件中的选择在服务器的帖子之间更改时引发该事件。 这允许为此事件提供自定义处理程序。 有关如何处理事件的详细信息，请参阅 处理和引发事件。
类 ListControl 实现 IEditableTextControl 接口，以便派生的列表类型控件可以在其他控件的模板模式下使用。
构造函数
| ListControl() |
初始化 ListControl 类的新实例。 |
属性
| AccessKey |
获取或设置使您得以快速导航到 Web 服务器控件的访问键。 (继承自 WebControl) |
| Adapter |
获取控件的浏览器特定适配器。 (继承自 Control) |
| AppendDataBoundItems |
获取或设置指示是否在绑定数据之前清除列表项的值。 |
| AppRelativeTemplateSourceDirectory |
获取或设置包含该控件的 Page 或 UserControl 对象的应用程序相对虚拟目录。 (继承自 Control) |
| Attributes |
获取与控件的特性不对应的任意特性（只用于呈现）的集合。 (继承自 WebControl) |
| AutoPostBack |
获取或设置一个值，该值指示当用户更改列表中的选定内容时是否自动产生向服务器的回发。 |
| BackColor |
获取或设置 Web 服务器控件的背景色。 (继承自 WebControl) |
| BindingContainer |
获取包含该控件的数据绑定的控件。 (继承自 Control) |
| BorderColor |
获取或设置 Web 控件的边框颜色。 (继承自 WebControl) |
| BorderStyle |
获取或设置 Web 服务器控件的边框样式。 (继承自 WebControl) |
| BorderWidth |
获取或设置 Web 服务器控件的边框宽度。 (继承自 WebControl) |
| CausesValidation |
获取或设置指示在单击从 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 中要绑定到控件的特定表。 |
| DataMember |
当数据源包含多个不同的数据项列表时，获取或设置数据绑定控件绑定到的数据列表的名称。 (继承自 DataBoundControl) |
| DataSource |
获取或设置填充列表控件项的数据源。 |
| DataSource |
获取或设置对象，数据绑定控件从该对象中检索其数据项列表。 (继承自 BaseDataBoundControl) |
| DataSourceID |
获取或设置控件的 ID，数据绑定控件从该控件中检索其数据项列表。 (继承自 DataBoundControl) |
| DataSourceObject |
获取一个对象，该对象实现 IDataSource 接口，以便提供对该对象的数据内容的访问。 (继承自 DataBoundControl) |
| DataTextField |
获取或设置为列表项提供文本内容的数据源字段。 |
| DataTextFormatString |
获取或设置格式化字符串，该字符串用来控制如何显示绑定到列表控件的数据。 |
| DataValueField |
获取或设置为各列表项提供值的数据源字段。 |
| 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 |
获取列表控件项的集合。 |
| ItemType |
获取或设置强类型化数据绑定的数据项目类型的名称。 (继承自 DataBoundControl) |
| LoadViewStateByID |
获取一个值，该值指示控件是否通过 ID 而不是索引参与加载其视图状态。 (继承自 Control) |
| NamingContainer |
获取对服务器控件的命名容器的引用，此引用创建唯一的命名空间，以区分具有相同 ID 属性值的服务器控件。 (继承自 Control) |
| Page |
获取对包含服务器控件的 Page 实例的引用。 (继承自 Control) |
| Parent |
获取对页 UI 层次结构中服务器控件的父控件的引用。 (继承自 Control) |
| RenderingCompatibility |
获取一个值，该值指定呈现的 HTML 将与之兼容的 ASP.NET 版本。 (继承自 Control) |
| RequiresDataBinding |
获取或设置一个值，该值指示是否应调用 DataBind() 方法。 (继承自 BaseDataBoundControl) |
| SelectArguments |
获取数据绑定控件从数据源控件检索数据时使用的 DataSourceSelectArguments 对象。 (继承自 DataBoundControl) |
| SelectedIndex |
获取或设置列表中选定项的最低序号索引。 |
| SelectedItem |
获取列表控件中索引最小的选定项。 |
| SelectedValue |
获取列表控件中选定项的值，或选择列表控件中包含指定值的项。 |
| SelectMethod |
为了读取数据要调用的方法的名称。 (继承自 DataBoundControl) |
| Site |
获取容器信息，该容器在呈现于设计图面上时承载当前控件。 (继承自 Control) |
| SkinID |
获取或设置要应用于控件的外观。 (继承自 WebControl) |
| Style |
获取将在 Web 服务器控件的外部标记上呈现为样式特性的文本特性的集合。 (继承自 WebControl) |
| SupportsDisabledAttribute |
获取一个值，该值指示在控件的 |
| SupportsDisabledAttribute |
获取一个值，该值指示在控件的 |
| TabIndex |
获取或设置 Web 服务器控件的选项卡索引。 (继承自 WebControl) |
| TagKey |
获取 ListControl 控件的 HtmlTextWriterTag 值。 |
| TagKey |
获取对应于此 Web 服务器控件的 HtmlTextWriterTag 值。 此属性主要由控件开发人员使用。 (继承自 WebControl) |
| TagName |
获取控件标记的名称。 此属性主要由控件开发人员使用。 (继承自 WebControl) |
| TemplateControl |
获取或设置对包含该控件的模板的引用。 (继承自 Control) |
| TemplateSourceDirectory |
获取包含当前服务器控件的 Page 或 UserControl 的虚拟目录。 (继承自 Control) |
| Text |
获取或设置 ListControl 控件的 SelectedValue 属性。 |
| ToolTip |
获取或设置当鼠标指针悬停在 Web 服务器控件上时显示的文本。 (继承自 WebControl) |
| UniqueID |
获取服务器控件的唯一的、以分层形式限定的标识符。 (继承自 Control) |
| ValidateRequestMode |
获取或设置指示控件是否检查来自浏览器的客户端输入是否具有潜在危险值的值。 (继承自 Control) |
| ValidationGroup |
获取或设置控件组，当从 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 |
当列表控件的选定项在信息发往服务器之间变化时发生。 |
| TextChanged |
当 Text 和 SelectedValue 属性更改时发生。 |
| Unload |
当服务器控件从内存中卸载时发生。 (继承自 Control) |
显式接口实现
扩展方法
| EnablePersistedSelection(BaseDataBoundControl) |
已过时.
使选定内容能够保留在支持选择和分页的数据控件中。 |
| FindDataSourceControl(Control) |
返回与指定控件的数据控件关联的数据源。 |
| FindFieldTemplate(Control, String) |
返回指定控件的命名容器中指定列的字段模板。 |
| FindMetaTable(Control) |
返回包含数据控件的元表对象。 |
