a575963da9
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
1184 lines
86 KiB
XML
1184 lines
86 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="HtmlSelect" FullName="System.Web.UI.HtmlControls.HtmlSelect">
|
|
<TypeSignature Language="C#" Maintainer="auto" Value="public class HtmlSelect : System.Web.UI.HtmlControls.HtmlContainerControl, System.Web.UI.IPostBackDataHandler" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Web</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
|
|
<Base>
|
|
<BaseTypeName>System.Web.UI.HtmlControls.HtmlContainerControl</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>System.Web.UI.IPostBackDataHandler</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Web.UI.SupportsEventValidation</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Web.UI.ControlBuilder(typeof(System.Web.UI.HtmlControls.HtmlSelectBuilder))</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.Web.UI.ValidationProperty("Value")</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultEvent("ServerChange")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control to create a selection box. Specify item listings in the control by placing HTML <option> elements between the opening and closing <select> tags. Each item is represented by a <see cref="T:System.Web.UI.WebControls.ListItem" /> object. To specify the text that is displayed for each item in the control, you can set the <see cref="P:System.Web.UI.WebControls.ListItem.Text" /> property of the item, or simply place text between the opening and closing <option> tags. By setting the <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> property of the item, you can associate a value with the item that is different from the text. To select an item from the list by default, set the <see cref="P:System.Web.UI.WebControls.ListItem.Selected" /> property of the item to true.</para>
|
|
<para>You can control the appearance and behavior of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Size" /> and <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Multiple" /> properties. The <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Size" /> property specifies the height (in rows) of the control. The <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Multiple" /> property specifies whether more than one item can be concurrently selected in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
<para>By default, the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control is displayed as a drop-down list box. If you allow multiple selections (by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Multiple" /> property to true) or specify a height greater than one row (by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Size" /> property to a value greater than 1), the control is displayed as a list box.</para>
|
|
<para>To determine the selected item in a single-selection <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control, use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndex" /> property to get the index of the selected item. You can then use this value to retrieve the item from the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection.</para>
|
|
<para>To determine the selected items from an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control that allows multiple selections, iterate through the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection and test the <see cref="P:System.Web.UI.WebControls.ListItem.Selected" /> property of each item.</para>
|
|
<para>The <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> class provides two properties to support data binding. To bind data to any object that implements the <see cref="T:System.Collections.IEnumerable" /> interface (such as <see cref="T:System.Data.DataView" />, <see cref="T:System.Collections.ArrayList" />, and <see cref="T:System.Collections.Generic.List`1" />), or the <see cref="T:System.ComponentModel.IListSource" /> interface, use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property to specify the data source to bind to. When you set the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property, you must manually write the code to perform the data binding. To automatically bind an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control to a data source represented by a data source control, use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property and set its value to the <see cref="P:System.Web.UI.Control.ID" /> property of the data source control to use. When you set the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property, the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control automatically binds to the specified data source control. Therefore, you do not need to explicitly call the <see cref="M:System.Web.UI.Control.DataBind" /> method.</para>
|
|
<para>You can also specify which fields in the data source bind to the <see cref="P:System.Web.UI.WebControls.ListItem.Text" /> and <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> properties of an item in the control by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataTextField" /> and <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataValueField" /> properties, respectively. If the data source contains multiple sources of data, use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataMember" /> property to specify the specific source to bind to the control. For example, if you have a <see cref="T:System.Data.DataSet" /> object with multiple tables, you must specify which table to bind to the control with the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataMember" /> property.</para>
|
|
<para>For a list of initial property values for an instance of <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" />, see the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.#ctor" /> constructor.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Allows programmatic access to the HTML <select> element on the server.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public HtmlSelect ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use this constructor to create and initialize a new instance of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> class.</para>
|
|
<para>The following table shows the initial property value for an instance of <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" />.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Property </para>
|
|
</term>
|
|
<description>
|
|
<para>Initial Value </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Web.UI.HtmlControls.HtmlControl.TagName" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>The "select" literal string. </para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> class.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="AddParsedSubObject">
|
|
<MemberSignature Language="C#" Value="protected override void AddParsedSubObject (object obj);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="obj" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.AddParsedSubObject(System.Object)" /> method is used by ASP.NET to add parsed child controls to the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Adds a parsed child control to the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
<param name="obj">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The parsed child control to add. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ClearSelection">
|
|
<MemberSignature Language="C#" Value="protected virtual void ClearSelection ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.ClearSelection" /> method iterates through the <see cref="T:System.Web.UI.WebControls.ListItemCollection" /> collection represented by the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> property and sets the <see cref="P:System.Web.UI.WebControls.ListItem.Selected" /> property of each <see cref="T:System.Web.UI.WebControls.ListItem" /> object to false.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Clears the list selection of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control and sets the <see cref="P:System.Web.UI.WebControls.ListItem.Selected" /> property of all items to false.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CreateControlCollection">
|
|
<MemberSignature Language="C#" Value="protected override System.Web.UI.ControlCollection CreateControlCollection ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Web.UI.ControlCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control does not allow child controls.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates an <see cref="T:System.Web.UI.EmptyControlCollection" /> object for the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A <see cref="T:System.Web.UI.ControlCollection" /> to contain the current server control's child server controls. </para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="DataMember">
|
|
<MemberSignature Language="C#" Value="public virtual string DataMember { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property contains multiple sets of data, use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataMember" /> property to specify which set of data to bind to the control. For example, if you have a <see cref="T:System.Data.DataSet" /> object with multiple tables, use this property to indicate which table to bind to the control.</para>
|
|
<para>After you have specified the data source to bind to the control, you can then specify which fields from the data source to bind to the <see cref="P:System.Web.UI.WebControls.ListItem.Text" /> and <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> properties of each item in the control by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataTextField" /> and <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataValueField" /> properties, respectively.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the set of data to bind to the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control from a <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property with multiple sets of data.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="DataSource">
|
|
<MemberSignature Language="C#" Value="public virtual object DataSource { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'object'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property to specify the data source to bind to the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control. A data source must be a collection that implements either the <see cref="T:System.Collections.IEnumerable" /> interface (such as <see cref="T:System.Data.DataView" />, <see cref="T:System.Collections.ArrayList" />, or <see cref="T:System.Collections.Generic.List`1" />) or the <see cref="T:System.ComponentModel.IListSource" /> interface. When you set the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property, you must manually write the code to perform data binding.</para>
|
|
<para>If the data source contains multiple sets of data, such as a <see cref="T:System.Data.DataSet" /> object with multiple tables, use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataMember" /> property to specify which data set to bind to the control.</para>
|
|
<para>You can specify which fields from the data source to bind to the <see cref="P:System.Web.UI.WebControls.ListItem.Text" /> and <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> properties of each item in the control by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataTextField" /> and <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataValueField" /> properties, respectively.</para>
|
|
<para>Alternately, you can use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property to automatically bind to a data source represented by a data source control. When you set the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property, the data listing control automatically binds to the specified data source control. You do not need to write code that explicitly calls the <see cref="M:System.Web.UI.Control.DataBind" /> method.</para>
|
|
<para>If values are specified for both the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property and the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property, ASP.NET is not able to resolve the data source and a <see cref="T:System.Web.HttpException" /> exception is thrown.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the source of information to bind to the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="DataSourceID">
|
|
<MemberSignature Language="C#" Value="public virtual string DataSourceID { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property to set or access the <see cref="P:System.Web.UI.Control.ID" /> property of the data source control that the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control should use to retrieve its data source. The data source control referenced by the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property can be any control that implements the <see cref="T:System.Web.UI.IDataSource" /> interface. The data source control must exist either in the same naming container as the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control that references it or in a parent control of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control. When you specify a value for this property, the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control automatically binds to the specified data source control. You do not need to write code that explicitly calls the <see cref="M:System.Web.UI.Control.DataBind" /> method.</para>
|
|
<para>Alternately, you can use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property to specify the source of values to bind to an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control. The data source must be a collection that implements the <see cref="T:System.Collections.IEnumerable" /> interface (such as <see cref="T:System.Data.DataView" />, <see cref="T:System.Collections.ArrayList" />, or <see cref="T:System.Collections.Generic.List`1" />) or the <see cref="T:System.ComponentModel.IListSource" /> interface. When you set the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property, you must manually write the code to perform data binding.</para>
|
|
<para>If values are specified for both the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property and the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property, ASP.NET is not able to resolve the data source and a <see cref="T:System.Web.HttpException" /> exception is thrown.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the <see cref="P:System.Web.UI.Control.ID" /> property of the data source control that the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control should use to retrieve its data source.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DataTextField">
|
|
<MemberSignature Language="C#" Value="public virtual string DataTextField { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataTextField" /> property to specify which field from the data source to bind to the <see cref="P:System.Web.UI.WebControls.ListItem.Text" /> property of each item in the control. This property is commonly used to provide a value for the <see cref="P:System.Web.UI.WebControls.ListItem.Text" /> property that differs from the value of the <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> property.</para>
|
|
<para>The <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> class provides two properties for specifying the data source to bind to. The <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property allows you to bind an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control to any collection that implements the <see cref="T:System.Collections.IEnumerable" /> or <see cref="T:System.ComponentModel.IListSource" /> interfaces (such as <see cref="T:System.Data.DataView" />, <see cref="T:System.Collections.ArrayList" />, or <see cref="T:System.Collections.Generic.List`1" />). When you use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property to specify the data source, you must explicitly call the <see cref="M:System.Web.UI.Control.DataBind" /> method to bind the control and its <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataTextField" /> property to the data source.</para>
|
|
<para>The <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property allows you to bind an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control to a data source control that represents a data source. When you use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property to specify the data source, the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control and its <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataTextField" /> property automatically bind to the specified data source control. Therefore, you do not need to explicitly call the <see cref="M:System.Web.UI.Control.DataBind" /> method.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the field from the data source to bind to the <see cref="P:System.Web.UI.WebControls.ListItem.Text" /> property of each item in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="DataValueField">
|
|
<MemberSignature Language="C#" Value="public virtual string DataValueField { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataValueField" /> property to specify which field from the data source to bind to the <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> property of each item in the control. This property is commonly used to provide a value for the <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> property that differs from the value of the <see cref="P:System.Web.UI.WebControls.ListItem.Text" /> property.</para>
|
|
<para>The <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> class provides two properties for specifying the data source to bind to. The <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property allows you to bind an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control to any collection that implements the <see cref="T:System.Collections.IEnumerable" /> or <see cref="T:System.ComponentModel.IListSource" /> interfaces (such as <see cref="T:System.Data.DataView" />, <see cref="T:System.Collections.ArrayList" />, or <see cref="T:System.Collections.Generic.List`1" />). When you use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property to specify the data source, you must explicitly call the <see cref="M:System.Web.UI.Control.DataBind" /> method to bind the control and its <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataValueField" /> property to the data source.</para>
|
|
<para>The <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property allows you to bind an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control to a data source control that represents a data source. When you use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property to specify the data source, the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control and its <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataValueField" /> property automatically bind to the data source control. Therefore, you do not need to explicitly call the <see cref="M:System.Web.UI.Control.DataBind" /> method. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the field from the data source to bind to the <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> property of each item in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="EnsureDataBound">
|
|
<MemberSignature Language="C#" Value="protected void EnsureDataBound ();" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When you specify a value for the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property, ASP.NET automatically binds the data listing control to the specified data source control. When ASP.NET performs data binding for the control, it calls the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.EnsureDataBound" /> method first to verify that the control has not already been data-bound and that a valid data source control that implements the <see cref="T:System.Web.UI.IDataSource" /> interface is specified for its <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property. The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.EnsureDataBound" /> method then calls the <see cref="M:System.Web.UI.Control.DataBind" /> method to ensure that the control is data-bound immediately after the call to this method.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Verifies that the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control requires data binding and that a valid data source control is specified before calling the <see cref="M:System.Web.UI.Control.DataBind" /> method.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetData">
|
|
<MemberSignature Language="C#" Value="protected virtual System.Collections.IEnumerable GetData ();" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.IEnumerable</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.GetData" /> method returns an <see cref="T:System.Collections.IEnumerable" /> object independent of whether the data source was specified by the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property or the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets an <see cref="T:System.Collections.IEnumerable" /> object that represents the data source that is bound to the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Collections.IEnumerable" /> object. If no data source is specified, a default value of null is returned.</para>
|
|
</returns>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="InnerHtml">
|
|
<MemberSignature Language="C#" Value="public override string InnerHtml { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>a <see cref="T:System.String" /></value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<block subset="none" type="note">
|
|
<para>Do not read from or assign a value to this property. Otherwise, a <see cref="T:System.NotSupportedException" /> exception is thrown. This property is inherited from the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> class and is not applicable to the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> class.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the content between the opening and closing tags of the control without automatically converting special characters to their equivalent HTML entities. This property is not supported for this control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="InnerText">
|
|
<MemberSignature Language="C#" Value="public override string InnerText { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>a <see cref="T:System.String" /></value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<block subset="none" type="note">
|
|
<para>Do not read from or assign a value to this property. Otherwise, a <see cref="T:System.NotSupportedException" /> exception is thrown. This property is inherited from the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> class and is not applicable to the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> class.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the content between the opening and closing tags of the control with automatic conversion of special characters to their equivalent HTML entities. This property is not supported for this control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="IsBoundUsingDataSourceID">
|
|
<MemberSignature Language="C#" Value="protected bool IsBoundUsingDataSourceID { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If the length of the string representing the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property string is greater than zero, then <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.IsBoundUsingDataSourceID" /> returns true.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a value indicating whether a <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property is defined for the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Items">
|
|
<MemberSignature Language="C#" Value="public System.Web.UI.WebControls.ListItemCollection Items { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Web.UI.WebControls.ListItemCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>a <see cref="T:System.Web.UI.WebControls.ListItemCollection" /></value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection to manage the items listed in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control. You can programmatically add items to, remove items from, and insert items into the collection.</para>
|
|
<para>The <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection is commonly used to iterate through the items in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control. For example, when multiple items are selected, you can iterate through the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection to determine which items are selected.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a collection that contains the items listed in an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="LoadPostData">
|
|
<MemberSignature Language="C#" Value="protected virtual bool LoadPostData (string postDataKey, System.Collections.Specialized.NameValueCollection postCollection);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="postDataKey" Type="System.String" />
|
|
<Parameter Name="postCollection" Type="System.Collections.Specialized.NameValueCollection" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.LoadPostData(System.String,System.Collections.Specialized.NameValueCollection)" /> method checks whether the postback data of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control is different from its previous value, and if so, returns true. If the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Multiple" /> property is false, indicating a single-selection <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control, then the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.LoadPostData(System.String,System.Collections.Specialized.NameValueCollection)" /> method checks the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndex" /> property. If the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Multiple" /> property is true, indicating a multiple-selection <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control, then the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.LoadPostData(System.String,System.Collections.Specialized.NameValueCollection)" /> method checks the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndices" /> property.</para>
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.LoadPostData(System.String,System.Collections.Specialized.NameValueCollection)" /> method is used primarily by control developers extending the functionality of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Processes the postback data for the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's state has changed as a result of a postback; otherwise, false.</para>
|
|
</returns>
|
|
<param name="postDataKey">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The key identifier for the control.</param>
|
|
<param name="postCollection">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The collection of all incoming name values.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LoadViewState">
|
|
<MemberSignature Language="C#" Value="protected override void LoadViewState (object savedState);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="savedState" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is used primarily by the .NET Framework infrastructure and is not intended to be used directly from your code. However, control developers can override this method to specify how a custom server control restores its view state. For more information, see <format type="text/html"><a href="0218d965-5d30-445b-b6a6-8870e70e63ce">ASP.NET State Management Overview</a></format>.</para>
|
|
<para>The <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's view state is stored as a <see cref="T:System.Web.UI.Triplet" /> object. The <see cref="F:System.Web.UI.Triplet.First" /> field of the <see cref="T:System.Web.UI.Triplet" /> object holds the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's base view state. The <see cref="F:System.Web.UI.Triplet.Second" /> field of the <see cref="T:System.Web.UI.Triplet" /> object holds the <see cref="T:System.Web.UI.WebControls.ListItemCollection" /> collection represented by the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> property. The <see cref="F:System.Web.UI.Triplet.Third" /> field of the <see cref="T:System.Web.UI.Triplet" /> object holds the selected indices represented by the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndices" /> property. The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.LoadViewState(System.Object)" /> method calls the base class's <see cref="M:System.Web.UI.HtmlControls.HtmlContainerControl.LoadViewState(System.Object)" /> method to restore the control's base view state.</para>
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.LoadViewState(System.Object)" /> method is used primarily by control developers extending the functionality of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Restores the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's view state information from a previous page request that was saved by the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.SaveViewState" /> method.</para>
|
|
</summary>
|
|
<param name="savedState">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> that represents the control state to be restored.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Multiple">
|
|
<MemberSignature Language="C#" Value="public bool Multiple { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'bool'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Multiple" /> property to specify whether multiple items can be concurrently selected in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
<para>By default, the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control is displayed as a drop-down list box. If you allow multiple selections (by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Multiple" /> property to true) or specify a height greater than one row (by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Size" /> property to a value greater than 1), the control is displayed as a list box.</para>
|
|
<para>To determine the selected items in an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control that allows multiple simultaneous selections, iterate through the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection and test the <see cref="P:System.Web.UI.WebControls.ListItem.Selected" /> property of each item.</para>
|
|
<block subset="none" type="note">
|
|
<para>The multiple attribute is rendered in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control only if this property is set to true.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value indicating whether multiple items can be selected concurrently in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Name">
|
|
<MemberSignature Language="C#" Value="public string Name { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Name" /> property to determine the unique identifier name for an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control. In this implementation, the get accessor returns the value of the <see cref="P:System.Web.UI.Control.UniqueID" /> property. However, the set accessor does not assign a value to this property.</para>
|
|
<block subset="none" type="note">
|
|
<para>The set accessor does not assign a value to this property because the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Name" /> property must have the same value as the <see cref="P:System.Web.UI.Control.UniqueID" /> property for the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control to work properly.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the unique identifier name associated with the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="OnDataBinding">
|
|
<MemberSignature Language="C#" Value="protected override void OnDataBinding (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="E:System.Web.UI.Control.DataBinding" /> event is raised when data is bound to the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control. This method notifies the control to perform any data-binding logic that is associated with it. Specifically, the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnDataBinding(System.EventArgs)" /> method creates the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection from the data source specified in either the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property or the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property.</para>
|
|
<para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="F2ADAF01-1ED1-42E1-8C31-8D467E7E0EE2">Raising an Event</a></format>.</para>
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnDataBinding(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Web.UI.Control.DataBinding" /> event of an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.EventArgs" /> that contains the event data. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnDataPropertyChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnDataPropertyChanged ();" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnDataPropertyChanged" /> method sets the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.RequiresDataBinding" /> property to true if the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" />, <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataMember" />, or <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property has changed.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Invoked when the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" />, <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataMember" />, or <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property is changed.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnDataSourceViewChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnDataSourceViewChanged (object sender, EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="sender" Type="System.Object" />
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnDataSourceViewChanged(System.Object,System.EventArgs)" /> method sets the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.RequiresDataBinding" /> property to true.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Invoked when the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" />, <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataMember" />, or <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property is changed.</para>
|
|
</summary>
|
|
<param name="sender">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnInit">
|
|
<MemberSignature Language="C#" Value="protected override void OnInit (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnInit(System.EventArgs)" /> method notifies the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control to perform any initialization steps that are required to create and set up an instance. If the <see cref="P:System.Web.UI.Control.IsViewStateEnabled" /> property is false and the <see cref="P:System.Web.UI.Page.IsPostBack" /> property is true, then the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.RequiresDataBinding" /> property is set to true.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Web.UI.Control.Init" /> event for the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.EventArgs" /> that contains the event data. </param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnLoad">
|
|
<MemberSignature Language="C#" Value="protected override void OnLoad (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnLoad(System.EventArgs)" /> method notifies the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control that it should perform actions common to each HTTP request for the page it is associated with. The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnLoad(System.EventArgs)" /> method connects the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control to the appropriate data source specified in either the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" /> property or the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property. If the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" /> property is to specify the data source control that the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control should use to retrieve its data source, then the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnDataSourceViewChanged(System.Object,System.EventArgs)" /> method is set as the event handler.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Web.UI.Control.Load" /> event for the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.EventArgs" /> that contains the event data. </param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnPagePreLoad">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnPagePreLoad (object sender, EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="sender" Type="System.Object" />
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="sender">To be added.</param>
|
|
<param name="e">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnPreRender">
|
|
<MemberSignature Language="C#" Value="protected override void OnPreRender (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Size" /> property is greater than 1, then the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnPreRender(System.EventArgs)" /> method registers the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control with the <see cref="T:System.Web.UI.Page" /> control as one that requires postback processing.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Web.UI.Control.PreRender" /> event for the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OnServerChange">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnServerChange (EventArgs e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.EventArgs" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="E:System.Web.UI.HtmlControls.HtmlSelect.ServerChange" /> event is raised when the selected items in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control change between posts to the server.</para>
|
|
<block subset="none" type="note">
|
|
<para>This event is raised only when the user initiates a post to the server, such as by clicking a Submit button. This event does not cause a post to the server to occur.</para>
|
|
</block>
|
|
<block subset="none" type="note">
|
|
<para>The control must have view state enabled for the <see cref="E:System.Web.UI.HtmlControls.HtmlSelect.ServerChange" /> event to work correctly.</para>
|
|
</block>
|
|
<para>You can use this event to perform data validation on the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control when the user changes the selection in the control.</para>
|
|
<para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="F2ADAF01-1ED1-42E1-8C31-8D467E7E0EE2">Raising an Event</a></format>.</para>
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnServerChange(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Raises the <see cref="E:System.Web.UI.HtmlControls.HtmlSelect.ServerChange" /> event of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control. This allows you to provide a custom handler for the event.</para>
|
|
</summary>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.EventArgs" /> that contains the event data. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="RaisePostDataChangedEvent">
|
|
<MemberSignature Language="C#" Value="protected virtual void RaisePostDataChangedEvent ();" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.RaisePostDataChangedEvent" /> method is used primarily by control developers extending the functionality of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Calls the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnServerChange(System.EventArgs)" /> method to signal the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control that the state of the control has changed.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RenderAttributes">
|
|
<MemberSignature Language="C#" Value="protected override void RenderAttributes (System.Web.UI.HtmlTextWriter w);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="w" Type="System.Web.UI.HtmlTextWriter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="w">a <see cref="T:System.Web.UI.HtmlTextWriter" /></param>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.RenderAttributes(System.Web.UI.HtmlTextWriter)" /> method renders the <paramref name="name" /> attribute of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control directly to ensure that it has the same value as the <see cref="P:System.Web.UI.Control.UniqueID" /> property. After rendering the attribute, the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.RenderAttributes(System.Web.UI.HtmlTextWriter)" /> method calls the base class's <see cref="M:System.Web.UI.HtmlControls.HtmlContainerControl.RenderAttributes(System.Web.UI.HtmlTextWriter)" /> method.</para>
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.RenderAttributes(System.Web.UI.HtmlTextWriter)" /> method is used primarily by control developers extending the functionality of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Renders the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's attributes to the specified <see cref="T:System.Web.UI.HtmlTextWriter" /> object.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="RenderChildren">
|
|
<MemberSignature Language="C#" Value="protected override void RenderChildren (System.Web.UI.HtmlTextWriter w);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="w" Type="System.Web.UI.HtmlTextWriter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="w">a <see cref="T:System.Web.UI.HtmlTextWriter" /></param>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.RenderChildren(System.Web.UI.HtmlTextWriter)" /> method overrides the base class's <see cref="M:System.Web.UI.Control.RenderChildren(System.Web.UI.HtmlTextWriter)" /> method without calling the base method. Each of the <option> elements between the opening and closing <select> tags is rendered with a <paramref name="value" /> attribute, a <paramref name="selected" /> attribute if the item is selected, and its associated text.</para>
|
|
<para>If multiple items were selected but the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Multiple" /> property is set to false, then an <see cref="T:System.Web.HttpException" /> exception is thrown.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Renders the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's child controls to the specified <see cref="T:System.Web.UI.HtmlTextWriter" /> object.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="RequiresDataBinding">
|
|
<MemberSignature Language="C#" Value="protected bool RequiresDataBinding { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control uses the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.RequiresDataBinding" /> property to determine whether the control needs to call the <see cref="M:System.Web.UI.Control.DataBind" /> method to bind to its specified data source.</para>
|
|
<para>Each time the set accessor is called on either the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSource" />, <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataSourceID" />, or <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.DataMember" /> property to change the data source after the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnInit(System.EventArgs)" /> method has already been called, ASP.NET automatically sets the value of the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.RequiresDataBinding" /> property to true. The value of the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.RequiresDataBinding" /> property is also set to true when the <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.OnDataPropertyChanged" /> method is invoked.</para>
|
|
<para>ASP.NET automatically sets the value of the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.RequiresDataBinding" /> property to false immediately after the <see cref="M:System.Web.UI.Control.DataBind" /> method has been called.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value indicating whether the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control needs to bind to its specified data source.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SaveViewState">
|
|
<MemberSignature Language="C#" Value="protected override object SaveViewState ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's view state is stored as a <see cref="T:System.Web.UI.Triplet" /> object. The <see cref="F:System.Web.UI.Triplet.First" /> field of the <see cref="T:System.Web.UI.Triplet" /> object holds the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's base view state. The <see cref="F:System.Web.UI.Triplet.Second" /> field of the <see cref="T:System.Web.UI.Triplet" /> object holds the <see cref="T:System.Web.UI.WebControls.ListItemCollection" /> collection represented by the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> property. The <see cref="F:System.Web.UI.Triplet.Third" /> field of the <see cref="T:System.Web.UI.Triplet" /> object holds the selected indices represented by the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndices" /> property. The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.SaveViewState" /> method calls the base class's <see cref="M:System.Web.UI.Control.SaveViewState" /> method to save the control's base view state.</para>
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.SaveViewState" /> method is used primarily by control developers extending the functionality of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Saves any <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control view state changes that have occurred since the page was posted back to the server.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Object" /> that contains the changes to the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> view state. If no view state is associated with the object, this method returns a null reference (Nothing in Visual Basic).</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Select">
|
|
<MemberSignature Language="C#" Value="protected virtual void Select (int[] selectedIndices);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="selectedIndices" Type="System.Int32[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.Select(System.Int32[])" /> method selects multiple items of the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Selects multiple items of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection.</para>
|
|
</summary>
|
|
<param name="selectedIndices">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Array" /> of type <see cref="T:System.Int32" /> that contains the items to select.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="SelectedIndex">
|
|
<MemberSignature Language="C#" Value="public virtual int SelectedIndex { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'int'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndex" /> property is commonly used to determine the index of the selected item in a single-selection <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control. This index can then be used to retrieve the item from the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection.</para>
|
|
<para>If the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Multiple" /> property is set to true, indicating that multiple items can be concurrently selected, the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndex" /> property contains the index of the first selected item. To determine the selected items from an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control that allows multiple simultaneous selections, iterate through the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection and test the <see cref="P:System.Web.UI.WebControls.ListItem.Selected" /> property of each item.</para>
|
|
<block subset="none" type="note">
|
|
<para>It is possible to have no item selected. If no item is selected, the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndex" /> property contains a value of -1. This commonly occurs when the page first loads and an item is not selected by default. Provide code to test this value before referencing the item in the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection. Otherwise, an exception is thrown if the index is out of the range of the collection.</para>
|
|
</block>
|
|
<para>By default, the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control is displayed as a drop-down list box. If you allow multiple selections (by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Multiple" /> property to true) or specify a height greater than one row (by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Size" /> property to a value greater than 1), the control is displayed as a list box. If a drop-down list box is displayed, an item is always selected. If a list box is displayed, you can programmatically clear the selection from all items by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndex" /> property to -1.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the ordinal index of the selected item in an <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="SelectedIndices">
|
|
<MemberSignature Language="C#" Value="protected virtual int[] SelectedIndices { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32[]</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added: an object of type 'int []'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndices" /> property is used by the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> class to return a collection that contains the zero-based indexes of all currently selected items in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
<para>Control developers extending the functionality of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> class can override the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndices" /> property to provide a custom algorithm for returning currently selected items.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a collection that contains the zero-based indexes of all currently selected items in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ServerChange">
|
|
<MemberSignature Language="C#" Value="public event EventHandler ServerChange;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="E:System.Web.UI.HtmlControls.HtmlSelect.ServerChange" /> event is raised when the selected items in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control change between posts to the server.</para>
|
|
<block subset="none" type="note">
|
|
<para>The control must have view state enabled for the <see cref="E:System.Web.UI.HtmlControls.HtmlSelect.ServerChange" /> event to work correctly.</para>
|
|
</block>
|
|
<para>For more information about handling events, see <format type="text/html"><a href="01E4F1BC-E55E-413F-98C7-6588493E5F67">Consuming Events</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Occurs when the selected items in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control change between posts to the server.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Size">
|
|
<MemberSignature Language="C#" Value="public int Size { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'int'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Size" /> property to specify the height (in rows) of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control. If you specify a size that is smaller than the number of items in the control, scroll bars are displayed to allow you to move up and down the list.</para>
|
|
<para>By default, the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control is displayed as a drop-down list box. If you allow multiple selections (by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Multiple" /> property to true) or specify a height greater than one row (by setting the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Size" /> property to a value greater than 1), the control is displayed as a list box.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the height (in rows) of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="System.Web.UI.IPostBackDataHandler.LoadPostData">
|
|
<MemberSignature Language="C#" Value="bool IPostBackDataHandler.LoadPostData (string postDataKey, System.Collections.Specialized.NameValueCollection postCollection);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="postDataKey" Type="System.String" />
|
|
<Parameter Name="postCollection" Type="System.Collections.Specialized.NameValueCollection" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> instance is cast to an <see cref="T:System.Web.UI.IPostBackDataHandler" /> interface.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>For a description of this member, see <see cref="M:System.Web.UI.IPostBackDataHandler.LoadPostData(System.String,System.Collections.Specialized.NameValueCollection)" />. </para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control's state has changed as a result of a postback; otherwise, false.</para>
|
|
</returns>
|
|
<param name="postDataKey">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The key identifier for the control.</param>
|
|
<param name="postCollection">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The collection of all incoming name values.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="System.Web.UI.IPostBackDataHandler.RaisePostDataChangedEvent">
|
|
<MemberSignature Language="C#" Value="void IPostBackDataHandler.RaisePostDataChangedEvent ();" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> instance is cast to an <see cref="T:System.Web.UI.IPostBackDataHandler" /> interface.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>For a description of this member, see <see cref="M:System.Web.UI.IPostBackDataHandler.RaisePostDataChangedEvent" />. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TrackViewState">
|
|
<MemberSignature Language="C#" Value="protected override void TrackViewState ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.UI.HtmlControls.HtmlSelect.TrackViewState" /> method persists items in the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Items" /> collection of the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control to view state.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Tracks view state changes to the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control so the changes can be stored in the control's <see cref="T:System.Web.UI.StateBag" /> object. This object is accessible through the <see cref="P:System.Web.UI.Control.ViewState" /> property.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Value">
|
|
<MemberSignature Language="C#" Value="public string Value { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.Value" /> property is commonly used to get the value of the item referenced by the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndex" /> property.</para>
|
|
<block subset="none" type="note">
|
|
<para>If no item is selected in the control, <see cref="F:System.String.Empty" /> is returned.</para>
|
|
</block>
|
|
<para>If you set this property to a value, the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndex" /> property is updated with the index of the first item in the list that contains that value. If no matching value is found, the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndex" /> property is left unchanged.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the value of the selected item in the <see cref="T:System.Web.UI.HtmlControls.HtmlSelect" /> control or sets the <see cref="P:System.Web.UI.HtmlControls.HtmlSelect.SelectedIndex" /> property of the control to the index of the first item in the list with the specified value.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
</Members>
|
|
</Type> |