Control.ClientID Свойство

Определение

Получает идентификатор элемента управления для HTML-разметки, созданной ASP.NET.Gets the control ID for HTML markup that is generated by ASP.NET.

public:
 virtual property System::String ^ ClientID { System::String ^ get(); };
[System.ComponentModel.Browsable(false)]
public virtual string ClientID { get; }
member this.ClientID : string
Public Overridable ReadOnly Property ClientID As String

Значение свойства

Идентификатор элемента управления для HTML-разметки, созданной ASP.NET.The control ID for HTML markup that is generated by ASP.NET.

Атрибуты

Примеры

В следующих примерах показан пользовательский веб-элемент управления, находящегося на странице содержимого главной страницы.The following examples show a Web user control that is inside a content page for a master page. Пользовательский элемент управления содержит элемент управления DropDownList и элемент управления Label.The user control contains a DropDownList control and a Label control. Текст, отображаемый в элементе управления Label, определяется значением, которое пользователь выбирает из элемента управления DropDownList.The text that is displayed in the Label control is determined by the value that the user selects from the DropDownList control. Текстовое значение задается через клиентский скрипт, чтобы веб-странице не нужно было отправлять обратно на сервер, чтобы задать это значение.The text value is set through client script so that the Web page does not have to post back to the server in order to set this value. Чтобы получить ссылку на HTML-элемент, отображаемый для Label элемента управления в клиентском скрипте, необходимо узнать значение свойства ClientID элемента управления.To get a reference to the HTML element that is rendered for the Label control in client script, you must know the value of the control's ClientID property. Однако, поскольку пользовательский элемент управления может размещаться в любом месте веб-страницы, невозможно заранее выяснить, какие контейнеры именования будут содержать элементы управления.However, because the user control can be put anywhere in a Web page, it is impossible to know in advance which naming containers will contain the controls. Чтобы убедиться, что значение ClientID будет таким же, как и значение ID, код задает для ClientIDMode значение Static.To make sure that the ClientID value will be the same as the ID value, the code sets the ClientIDMode value to Static.

В следующем примере показан пользовательский элемент управления.The following example shows the user control.

В следующем примере показана страница содержимого, содержащая пользовательский элемент управления.The following example shows the content page that contains the user control.

В следующем примере показана Главная страница, содержащая страницу содержимого.The following example shows the master page that contains the content page.

Комментарии

Когда серверный веб-элемент управления подготавливается к просмотру как элемент HTML, атрибуту id элемента HTML присваивается значение свойства ClientID.When a Web server control is rendered as an HTML element, the id attribute of the HTML element is set to the value of the ClientID property. Значение ClientID часто используется для доступа к элементу HTML в клиентском скрипте с помощью метода document.getElementById.The ClientID value is often used to access the HTML element in client script by using the document.getElementById method. Идентификатор также часто используется в правилах CSS для указания элементов стиля.The ID is also often used in CSS rules to specify elements to style. Например, следующее правило стиля CSS выбирает все элементы span, которые имеют id значение атрибута ProductIDLabel, и задает для их background-color атрибут white.For example, the following CSS style rule selects all span elements that have the id attribute value of ProductIDLabel and sets their background-color attribute to white:

span#ProductIDLabel { background-color: white; }  

ASP.NET предоставляет несколько алгоритмов для создания значения свойства ClientID.ASP.NET provides multiple algorithms for how to generate the ClientID property value. Выберите алгоритм, который будет использоваться для элемента управления, задав его свойство ClientIDMode.You select which algorithm to use for a control by setting its ClientIDMode property. Алгоритмы идентифицируются по значениям перечисления ClientIDMode, которые перечислены в следующей таблице.The algorithms are identified by the ClientIDMode enumeration values that are listed in the following table.

ЗначениеValue ОписаниеDescription
AutoID Значение свойства ClientID формируется путем сцепления значений свойства ID каждого из родительских контейнеров именования со значением свойства ID элемента управления.The ClientID value is generated by concatenating the ID values of each parent naming container with the ID value of the control. В сценариях с привязкой данных, где отрисовывается несколько экземпляров элемента управления, перед значением свойства ID элемента управления вставляется значение счетчика.In data-binding scenarios where multiple instances of a control are rendered, an incrementing value is inserted in front of the control's ID value. Все сегменты разделяются символом подчеркивания ().Each segment is separated by an underscore character (). Этот алгоритм использовался в версиях ASP.NET, предшествующих ASP.NET 4.This algorithm was used in versions of ASP.NET earlier than ASP.NET 4.
Static Значение свойства ClientID задается равным значению свойства ID.The ClientID value is set to the value of the ID property. Если элемент управления представляет собой контейнер именования, он выступает в качестве верхнего уровня иерархии контейнеров именования для всех элементов управления, которые он содержит.If the control is a naming container, the control is used as the top of the hierarchy of naming containers for any controls that it contains.
Predictable Этот алгоритм используется для элементов управления, содержащихся в элементах управления с привязкой к данным.This algorithm is used for controls that are in data-bound controls. Значение свойства ClientID формируется путем сцепления значения свойства ClientID родительского контейнера именования со значением свойства ID элемента управления.The ClientID value is generated by concatenating the ClientID value of the parent naming container with the ID value of the control. Если элемент управления представляет собой элемент управления с привязкой к данным, формирующий несколько строк, в конец идентификатора добавляется значение поля данных, указанного в свойстве ClientIDRowSuffix.If the control is a data-bound control that generates multiple rows, the value of the data field specified in the ClientIDRowSuffix property is added at the end. Для элемента управления GridView может быть указано несколько полей данных.For the GridView control, multiple data fields can be specified. Если свойство ClientIDRowSuffix пусто, в конец добавляется порядковый номер, а не значение поля данных.If the ClientIDRowSuffix property is blank, a sequential number is added at the end instead of a data-field value. Все сегменты разделяются символом подчеркивания ().Each segment is separated by an underscore character ().
Inherit Элемент управления наследует значение ClientIDMode от элемента управления NamingContainer.The control inherits the ClientIDMode setting of its NamingContainer control.

Значение по умолчанию ClientIDMode для страницы — Predictable.The default value of ClientIDMode for a page is Predictable. Значение по умолчанию ClientIDMode для элемента управления — Inherit.The default value of ClientIDMode for a control is Inherit. Так как по умолчанию для элементов управления используется Inherit, режим создания по умолчанию — Predictable.Because the default for controls is Inherit, the default generation mode is Predictable. (Однако, если вы используете Visual Studio для преобразования веб-проекта в ASP.NET 4 из более ранней версии, Visual Studio автоматически устанавливает для сайта по умолчанию значение AutoID в файле Web. config.)(However, if you use Visual Studio to convert a Web project to ASP.NET 4 from an earlier version, Visual Studio automatically sets the site default to AutoID in the Web.config file.)

Дополнительные сведения см. в разделе Идентификация элементов управления Web Forms.For more information, see ASP.NET Web Server Control Identification.

Применяется к

Дополнительно