Identification du contrôle serveur Web ASP.NET

Les contrôles serveur Web ASP.NET incluent les propriétés suivantes qui jouent le rôle d'identificateurs :

• ID. ID que vous spécifiez dans le balisage ou en définissant la propriété ID du contrôle.

• UniqueID. ID généré par ASP.NET en vue d'être utilisé par le code qui s'exécute sur le serveur.

• ClientID. ID généré par ASP.NET en vue d'être utilisé par le code client (il est restitué en tant que valeur de l'attribut id dans le code HTML).

Propriété UniqueID

Propriété ClientID

Lorsqu'un contrôle ne se trouve pas à l'intérieur d'un conteneur d'attribution de noms ni d'un contrôle lié aux données, ASP.NET utilise la valeur d'ID de la propriété UniqueID et la propriété ClientID. L'exemple suivant montre un contrôle Label qui ne se trouve pas à l'intérieur d'un conteneur d'attribution de noms :

<asp:Label ID="Label1" runat="server"

  ClientIDMode=valeur

  Text="Label">

</asp:Label>

Lorsqu'un contrôle ne se trouve pas à l'intérieur d'un conteneur d'attribution de noms, la propriété ClientIDMode n'affecte pas la valeur de propriété ClientID générée. Tous les ID sont de ce fait les mêmes, quelle que soit la valeur que vous affectez à la propriété ClientIDMode.

Lorsque la page s'exécute, le contrôle Label1 a les valeurs de propriété suivantes :

• ID: Label1

• UniqueID: Label1

• ClientID: Label1

Lorsqu'un contrôle se trouve à l'intérieur d'un conteneur d'attribution de noms, ASP.NET génère la valeur de propriété UniqueID et la valeur de propriété ClientID en combinant les valeurs ID de tous les contrôles figurant dans la hiérarchie d'imbrication. Si toutefois le ClientIDMode de tout contrôle figurant dans la hiérarchie d'imbrication a la valeur Static, les valeurs ID des contrôles qui sont situés plus haut dans la hiérarchie ne sont pas incluses.

Les conteneurs d'attribution de noms communs incluent des pages maîtres et des pages de contenu. L'exemple suivant montre un contrôle Label qui se trouve dans un contrôle utilisateur. Le contrôle utilisateur se trouve à l'intérieur d'une page de contenu qui se trouve elle-même à l'intérieur d'une page maître.

Remarque
Seules les sections pertinentes de la page maître, de la page de contenu et du contrôle utilisateur sont indiquées dans les exemples suivants.

La page maître contient l'espace réservé de contenu suivant :

<asp:ContentPlaceHolder ID="ContentPlaceHolder1" runat="server">

</asp:ContentPlaceHolder>

La page de contenu contient la section de contenu suivante :

<asp:Content ID="Content2"

  ContentPlaceHolderID="ContentPlaceHolder1"

  Runat="server">

  <uc:ExampleLabelControl ID="CustomUserControl1" runat="server" />

</asp:Content>

Le contrôle utilisateur contient le contrôle Label suivant :

<asp:Label ClientIDMode=valeur

  ID="NestedExampleLabel"

  Text="Example" >

</asp:Label>

Si vous affectez à la propriété ClientIDMode du contrôle Label la valeur AutoID, lorsque la page s'exécute, le contrôle NestedExampleLabel a les valeurs de propriété suivantes :

• ID: NestedExampleLabel

• UniqueID: ctl00$ContentPlaceHolder1$CustomUserControl1$NestedExampleLabel

• ClientID: ctl00_ContentPlaceHolder1_CustomUserControl1_NestedExampleLabel

Si vous affectez à la propriété ClientIDMode du contrôle Label la valeur Static, lorsque la page s'exécute, le contrôle NestedExampleLabel a les valeurs de propriété suivantes :

• ID: NestedExampleLabel

• UniqueID: ctl00$ContentPlaceHolder1$CustomUserControl1$NestedExampleLabel

• ClientID: NestedExampleLabel

Lorsqu'un contrôle se trouve à l'intérieur d'un contrôle lié aux données qui génère des instances répétées de ce contrôle, ASP.NET génère les valeurs UniqueID et ClientID de chaque instance du contrôle. La valeur UniqueID est générée en combinant la valeur UniqueID du conteneur d'attribution de noms, la valeur ID du contrôle et un numéro séquentiel. Tel est le cas avec des contrôles comme DataList, Repeater, GridView et ListView.

ASP.NET génère des valeurs ClientID de façon similaire lorsque la propriété ClientIDMode a la valeur AutoID. Cela peut rendre le référencement du contrôle difficile dans le script client, car vous ne pouvez généralement pas prédire les valeurs des numéros séquentiels utilisés. Si vous souhaitez accéder aux contrôles liés aux données à partir du script client, vous pouvez affecter à la propriété ClientIDMode la valeur Predictable. Cela facilite la prédiction des valeurs ClientID.

Lorsque vous affectez au ClientIDMode la valeur Predictable, vous pouvez également affecter à la propriété ClientIDRowSuffixDataKeys le nom d'un champ de données qui est unique (clé primaire dans une table de base de données, par exemple). ASP.NET génère alors un ID client qui est plus facile à prédire et à référencer dans le script client si vous pouvez prédire les valeurs des clés des données.

Lorsque vous affectez à la propriété ClientIDMode la valeur Static dans un scénario de liaison de données, aucune exception n'est levée. La valeur de ClientID est toutefois la même pour tous les contrôles. Dans ce cas, vous n'êtes pas en mesure d'utiliser l'attribut id HTML pour référencer un contrôle spécifique dans le script client.

L'exemple suivant montre un contrôle XmlDataSource, un contrôle ListView qui y est lié et les contrôles Label qui se trouvent dans le contrôle ListView.

<asp:XmlDataSource ID="XmlDataSource1" runat="server" 
                   XPath="Products/Product">
  <Data>
    <Products>
      <Product ProductID="1"  ProductName="Chai" />
      <Product ProductID="34" ProductName="Ale" />
      <Product ProductID="43" ProductName="Coffee" />
    </Products>
  </Data>
</asp:XmlDataSource>

<asp:ListView ID="ListView1" 
              ClientIDMode="Predictable" 
              ClientIDRowSuffix="ProductID"  
              DataSourceID="XmlDataSource1" runat="server" >
  <ItemTemplate>
    ProductID: 
    <asp:Label ID="ProductIDLabel" runat="server" 
               Text='<%# Eval("ProductID") %>' />
    <br />
    ProductName:
    <asp:Label ID="ProductNameLabel" runat="server" 
               Text='<%# Eval("ProductName") %>' />
    <br />
    <br />
  </ItemTemplate>

  <LayoutTemplate>
    <div ID="itemPlaceholderContainer" runat="server">
      <span ID="itemPlaceholder" runat="server" />
    </div>
    <div>
    </div>
  </LayoutTemplate>

</asp:ListView>

Quelle que soit la valeur affectée à la propriété ClientIDMode du contrôle ListView, les valeurs UniqueID des contrôles ProductIDLabel sont les suivantes :

• UniqueID:

  • ListView1$ctrl0$ProductIDLabel

  • ListView1$ctrl1$ProductIDLabel

  • ListView1$ctrl2$ProductIDLabel

Lorsque vous affectez à la propriété ClientIDMode du contrôle ListView la valeur AutoID, les valeurs ClientID suivantes sont générées pour les contrôles ProductIDLabel :

• ClientID:

  • ListView1_ctrl0_ProductIDLabel

  • ListView1_ctrl1_ProductIDLabel

  • ListView1_ctrl2_ProductIDLabel

Lorsque vous affectez à la propriété ClientIDMode du contrôle ListView la valeur Static, les valeurs ClientID suivantes sont générées pour les contrôles ProductIDLabel :

• ClientID:

  • ProductIDLabel

  • ProductIDLabel

  • ProductIDLabel

Lorsque vous affectez à la propriété ClientIDMode du contrôle ListView la valeur Predictable, avec ClientIDRowSuffix qui a la valeur ProductID, les valeurs ClientID suivantes sont générées pour les contrôles ProductIDLabel :

• ClientID:

  • ListView1_ProductIDLabel_1

  • ListView1_ProductIDLabel_34

  • ListView1_ProductIDLabel_43

Cet exemple montre un contrôle lié aux données qui se trouve dans une page Web. Lorsque vous placez un contrôle lié aux données dans un contrôle utilisateur, la partie de la valeur ClientID qui précède la valeur ID du contrôle varie en fonction de la page sur laquelle le contrôle utilisateur se trouve ou du contrôle contenant dans lequel elle se trouve. Cela rend les valeurs ClientID imprévisibles, même si vous affectez à la propriété ClientIDMode la valeur Predictable. Pour y remédier, vous pouvez affecter au ClientIDMode du contrôle conteneur parent du contrôle lié aux données la valeur Static. Lorsque vous affectez au ClientIDMode d'un contrôle conteneur la valeur Static et que vous affectez à la propriété ClientIDMode d'un contrôle lié aux données se trouvant à l'intérieur la valeur Predictable, les valeurs ClientID générées pour le contrôle lié aux données commencent toujours par l'ID du contrôle conteneur, quels que soient le ou les contrôles dans lesquels le contrôle conteneur se trouve.

Pour utiliser des contrôles dans le code, vous pouvez obtenir une référence au contrôle à l'aide de l'une de ses propriétés ID.

Référencement de contrôles par ID

Tâches

Référence