Cette documentation est archivée et n’est pas conservée.

Control.ClientID, propriété

Mise à jour : novembre 2007

Obtient l'identificateur de contrôle serveur généré par ASP.NET.

Espace de noms :  System.Web.UI
Assembly :  System.Web (dans System.Web.dll)

[BrowsableAttribute(false)]
public virtual string ClientID { get; }
/** @property */
/** @attribute BrowsableAttribute(false) */
public String get_ClientID()

public function get ClientID () : String

Valeur de propriété

Type : System.String

Identificateur de contrôle serveur généré par ASP.NET.

Il est parfois impossible d'assigner un nom unique à un contrôle. Par exemple, si un contrôle Repeater contient un contrôle Label dans l'un de ses modèles, une instance de ce contrôle Label est rendue pour chaque élément dans le contrôle Repeater. Pour éviter les conflits de nommage lorsque plusieurs instances d'un contrôle sont rendues, ASP.NET génère automatiquement une valeur ClientID unique pour chaque contrôle serveur sur une page. La valeur ClientID est générée en concaténant la valeur ID du contrôle et la valeur UniqueID de son contrôle parent. Si la valeur ID du contrôle n'est pas spécifiée, une valeur générée automatiquement est utilisée. Chaque partie de l'ID généré est séparée par un trait de soulignement (_).

Remarque :

La valeur ClientID générée pour un contrôle est identique à la valeur UniqueID, à la différence qu'un trait de soulignement est utilisé pour délimiter les valeurs d'ID au lieu du caractère spécifié par la propriété IdSeparator. Par défaut, un signe deux-points (:) est affecté à la propriété IdSeparator. La valeur ClientID ne contenant pas de signes deux-points, elle peut être utilisée dans ECMAScript, qui ne prend pas en charge les ID contenant des signes deux-points.

La valeur ClientID est souvent utilisée pour accéder par programme à l'élément HTML rendu pour un contrôle dans un script côté client. Pour plus d'informations, consultez Script client dans les pages Web ASP.NET.

L'exemple suivant parcourt l'objet ControlCollection d'une page et affiche la propriété ClientID pour chaque contrôle de la page.

void Page_Load(object sender,EventArgs e)
{
       Response.Write("<h4>Control_ClientID Sample</h4>");
       // Get the list of all controls.
      IEnumerator myEnumerator = Controls.GetEnumerator();
      Response.Write("<br />Enumerating Controls Collection<br />");    
      while(myEnumerator.MoveNext())
      {
          Control   myControl = (Control) myEnumerator.Current;
          // Display the ClientID property 
          Response.Write("<br />The ClientID property of Control : " + myControl.ClientID);
       }
 }


void Page_Load(Object sender, EventArgs e) 
{
    get_Response().Write("<h4>Control_ClientID Sample</h4>");

    // Get the list of all controls.
    IEnumerator myEnumerator = get_Controls().GetEnumerator();
    get_Response().Write("<br />Enumerating Controls Collection<br />");
    while(myEnumerator.MoveNext()) {
  Control myControl = (Control)(myEnumerator.get_Current());
  // Display the ClientID property 
  get_Response().Write("<br />The ClientID property of Control : " 
      + myControl.get_ClientID());
    }
} //Page_Load


Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professionnel Édition x64, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

Le .NET Framework et le .NET Compact Framework ne prennent pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.

.NET Framework

Pris en charge dans : 3.5, 3.0, 2.0, 1.1, 1.0
Afficher: