ClientIDMode Énumération

  • Référence

Définition

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

Spécifie la façon dont ASP.NET génère ClientID pour un contrôle accessible dans un script client.

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

Champs

AutoID 1

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. 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. Chaque segment est séparé par un trait de soulignement (_). Cet algorithme est le seul qui était disponible dans les versions d’ASP.NET antérieures à ASP.NET 4.
Inherit 0

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

Cet algorithme est utilisé pour les contrôles contenus dans des contrôles liés aux données. 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. 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. Pour le contrôle GridView, plusieurs champs de données peuvent être spécifiés. Si la propriété ClientIDRowSuffix est vide, un numéro séquentiel est ajouté à la fin au lieu d'une valeur de champ de données. Chaque segment est séparé par un trait de soulignement (_).
Static 3

La propriété ClientID a la valeur de la propriété ID. 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.

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 propriété a la ProductIDClientIDRowSuffix valeur . À partir du script client, vous pouvez accéder à une instance particulière d’un Label en fonction de la ProductID valeur de l’instance à laquelle 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é d’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 d’un script client. La valeur que vous attribuez à la ClientIDMode propriété n’affecte pas la ID propriété du contrôle serveur, mais uniquement 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 pour les contrôles est Hériter, 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 pour 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 Identification du contrôle serveur web ASP.NET.

S’applique à

Voir aussi