Partager via

ClientIDMode Énumération

Définition

Espace de noms:
System.Web.UI
Assembly:
System.Web.dll

Spécifie comment ASP.NET génère l'ClientID d’un contrôle accessible dans le script client.

public enum class ClientIDMode
public enum ClientIDMode
type ClientIDMode = 
Public Enum ClientIDMode
Héritage
Object
ValueType
Enum
ClientIDMode

Champs

Nom Valeur Description
Inherit 0

Le contrôle hérite du ClientIDMode paramètre de son NamingContainer contrôle.
AutoID 1

La ClientID valeur est générée en concaténant les ID valeurs de chaque conteneur d’affectation de noms parent avec la ID valeur du contrôle. Dans les scénarios de liaison de données où plusieurs instances d’un contrôle sont rendues, une valeur d’incrémentation est insérée devant la valeur du ID contrôle. Chaque segment est séparé par un caractère de soulignement (_). Cet algorithme est le seul disponible dans les versions de ASP.NET antérieures à ASP.NET 4.
Predictable 2

Cet algorithme est utilisé pour les contrôles qui se trouvent dans des contrôles liés aux données. La ClientID valeur est générée en concaténant la ClientID valeur du conteneur d’affectation de noms parent avec la ID valeur du contrôle. 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é dans la ClientIDRowSuffix propriété est ajoutée à la fin. Pour le GridView contrôle, plusieurs champs de données peuvent être spécifiés. Si la ClientIDRowSuffix propriété est vide, un nombre séquentiel est ajouté à la fin au lieu d’une valeur de champ de données. Chaque segment est séparé par un caractère de soulignement (_).
Static 3

La ClientID valeur est définie sur la valeur de la ID propriété. Si le contrôle est un conteneur d’affectation de noms, le contrôle est utilisé en haut de la hiérarchie des conteneurs d’affectation de noms pour tous les contrôles qu’il contient.

Exemples

L’exemple suivant montre Label les contrôles contenus dans un ListView contrôle. Sur le ListView contrôle, la ClientIDMode propriété est définie sur Prédictible et la ClientIDRowSuffix propriété a la valeur ProductID. À partir du script client, vous pouvez accéder à une instance particulière d’une Label instance basée sur la ProductID valeur de l’instance que vous essayez d’accéder.

Cet exemple crée du code HTML avec trois ProductIDLabel contrôles. Lorsque la page s’exécute, les ID des contrôles sont les suivants :

  • ListView1_ProductIDLabel_1
  • ListView1_ProductIDLabel_34
  • ListView1_ProductIDLabel_43
<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>

Remarques

Vous utilisez l’énumération ClientIDMode lorsque vous définissez la ClientIDMode propriété pour un contrôle. La valeur que vous affectez à la ClientIDMode propriété détermine la façon dont la ClientID propriété est générée. La valeur de la ClientID propriété est affichée en tant qu’attribut dans le id balisage, et il s’agit de la valeur que vous utilisez pour accéder au contrôle à partir du script client. La valeur que vous affectez à la ClientIDMode propriété n’affecte pas la ID propriété du contrôle serveur, seul l’attribut id de l’élément HTML correspondant.

La valeur par défaut d’une ClientIDMode page est prévisible. La valeur par défaut d’un ClientIDMode contrôle est Hériter.

Étant donné que la valeur par défaut des contrôles est Inherit, le mode de génération par défaut est prévisible. (Toutefois, si vous utilisez Visual Studio pour convertir un projet Web en ASP.NET 4 à partir d’une version antérieure, Visual Studio définit automatiquement le site par défaut sur AutoID dans le fichier Web.config.)

Vous pouvez définir la ClientIDMode valeur de toutes les pages d’un site Web en définissant l’élément pages dans le fichier Web.config du site. Vous pouvez définir la ClientIDMode valeur d’une page dans la directive @ Page .

Pour plus d’informations, consultez ASP.NET Identification du contrôle de serveur web.

S’applique à

Voir aussi