Control.ClientID Propriété

Définition

Obtient l’ID de contrôle du balisage HTML généré par 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

Valeur de propriété

ID de contrôle du balisage HTML généré par ASP.NET.The control ID for HTML markup that is generated by ASP.NET.

Attributs

Exemples

Les exemples suivants illustrent un contrôle utilisateur Web situé dans une page de contenu pour une page maître.The following examples show a Web user control that is inside a content page for a master page. Le contrôle utilisateur contient un contrôle DropDownList et un contrôle Label.The user control contains a DropDownList control and a Label control. Le texte affiché dans le contrôle Label est déterminé par la valeur que l’utilisateur sélectionne dans le contrôle DropDownList.The text that is displayed in the Label control is determined by the value that the user selects from the DropDownList control. La valeur texte est définie via le script client afin que la page Web n’ait pas à effectuer de publication sur le serveur pour définir cette valeur.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. Pour obtenir une référence à l’élément HTML restitué pour le contrôle Label dans le script client, vous devez connaître la valeur de la propriété ClientID du contrôle.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. Toutefois, étant donné que le contrôle utilisateur peut être placé n’importe où dans une page Web, il est impossible de savoir à l’avance quels conteneurs d’attribution de noms contiendront les contrôles.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. Pour vous assurer que la valeur ClientID est identique à la valeur ID, le code définit la valeur ClientIDMode sur Static.To make sure that the ClientID value will be the same as the ID value, the code sets the ClientIDMode value to Static.

L’exemple suivant montre le contrôle utilisateur.The following example shows the user control.

L’exemple suivant affiche la page de contenu qui contient le contrôle utilisateur.The following example shows the content page that contains the user control.

L’exemple suivant affiche la page maître qui contient la page de contenu.The following example shows the master page that contains the content page.

Remarques

Lorsqu’un contrôle serveur Web est rendu sous la forme d’un élément HTML, l’attribut id de l’élément HTML est défini sur la valeur de la propriété 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. La valeur ClientID est souvent utilisée pour accéder à l’élément HTML dans le script client à l’aide de la méthode document.getElementById.The ClientID value is often used to access the HTML element in client script by using the document.getElementById method. L’ID est également souvent utilisé dans les règles CSS pour spécifier des éléments à appliquer au style.The ID is also often used in CSS rules to specify elements to style. Par exemple, la règle de style CSS suivante sélectionne tous les éléments span qui ont la valeur d’attribut id de ProductIDLabel et définit leur attribut background-color sur 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 fournit plusieurs algorithmes pour la génération de la valeur de propriété ClientID.ASP.NET provides multiple algorithms for how to generate the ClientID property value. Vous sélectionnez l’algorithme à utiliser pour un contrôle en définissant sa propriété ClientIDMode.You select which algorithm to use for a control by setting its ClientIDMode property. Les algorithmes sont identifiés par les valeurs d’énumération ClientIDMode qui sont répertoriées dans le tableau suivant.The algorithms are identified by the ClientIDMode enumeration values that are listed in the following table.

ValueValue DescriptionDescription
AutoID La valeur de la propriété ClientID est générée par concaténation des valeurs de la propriété ID de chaque conteneur d'attribution de noms parent à la valeur de la propriété ID du contrôle.The ClientID value is generated by concatenating the ID values of each parent naming container with the ID value of the control. Dans les scénarios de liaison de données où plusieurs instances d'un contrôle sont restituées, une valeur d'incrémentation est insérée devant la valeur de la propriété ID du contrôle.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. Chaque segment est séparé par un trait de soulignement ().Each segment is separated by an underscore character (). Cet algorithme a été utilisé dans les versions de ASP.NET antérieures à ASP.NET 4.This algorithm was used in versions of ASP.NET earlier than ASP.NET 4.
Static La propriété ClientID a la valeur de la propriété ID.The ClientID value is set to the value of the ID property. Si le contrôle est un conteneur d'attribution de noms, il est utilisé comme élément le plus élevé de la hiérarchie des conteneurs d'attribution de noms pour tous les contrôles qu'il contient.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 Cet algorithme est utilisé pour les contrôles contenus dans des contrôles liés aux données.This algorithm is used for controls that are in data-bound controls. La valeur de la propriété ClientID est générée par concaténation de la valeur de la propriété ClientID du conteneur d'attribution de noms parent à la valeur de la propriété ID du contrôle.The ClientID value is generated by concatenating the ClientID value of the parent naming container with the ID value of the control. Si le contrôle est un contrôle lié aux données qui génère plusieurs lignes, la valeur du champ de données spécifiée dans la propriété ClientIDRowSuffix est ajoutée à la fin.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. Pour le contrôle GridView, plusieurs champs de données peuvent être spécifiés.For the GridView control, multiple data fields can be specified. Si la propriété ClientIDRowSuffix est vide, un nombre séquentiel est ajouté à la fin au lieu d’une valeur de champ de données.If the ClientIDRowSuffix property is blank, a sequential number is added at the end instead of a data-field value. Chaque segment est séparé par un trait de soulignement ().Each segment is separated by an underscore character ().
Inherit Le contrôle hérite du paramètre de ClientIDMode de son contrôle NamingContainer.The control inherits the ClientIDMode setting of its NamingContainer control.

La valeur par défaut de ClientIDMode pour une page est Predictable.The default value of ClientIDMode for a page is Predictable. La valeur par défaut de ClientIDMode pour un contrôle est Inherit.The default value of ClientIDMode for a control is Inherit. Étant donné que la valeur par défaut pour les contrôles est Inherit, le mode de génération par défaut est Predictable.Because the default for controls is Inherit, the default generation mode is Predictable. (Toutefois, si vous utilisez Visual Studio pour convertir un projet Web en ASP.NET 4 d’une version antérieure, Visual Studio définit automatiquement la valeur par défaut du site sur AutoID dans le fichier 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.)

Pour plus d’informations, consultez Identification du contrôle serveur web ASP.NET.For more information, see ASP.NET Web Server Control Identification.

S’applique à

Voir aussi