Control.ClientID Eigenschaft

Definition

Ruft die Steuerelement-ID für HTML-Markup ab, das von ASP.NET generiert wird.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

Eigenschaftswert

Die Steuerelement-ID für HTML-Markup, das von ASP.NET generiert wird.The control ID for HTML markup that is generated by ASP.NET.

Attribute

Beispiele

In den folgenden Beispielen wird ein Webbenutzer Steuerelement gezeigt, das sich auf einer Inhaltsseite für eine Master Seite befindet.The following examples show a Web user control that is inside a content page for a master page. Das Benutzer Steuerelement enthält ein DropDownList-Steuerelement und ein Label-Steuerelement.The user control contains a DropDownList control and a Label control. Der Text, der im Label Steuerelement angezeigt wird, wird durch den Wert bestimmt, den der Benutzer aus dem DropDownList Steuerelement auswählt.The text that is displayed in the Label control is determined by the value that the user selects from the DropDownList control. Der Textwert wird durch ein Client Skript festgelegt, sodass die Webseite nicht an den Server zurückgesendet werden muss, um diesen Wert festzulegen.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. Um einen Verweis auf das HTML-Element zu erhalten, das für das Label-Steuerelement im Client Skript gerendert wird, müssen Sie den Wert der ClientID-Eigenschaft des Steuer Elements kennen.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. Da das Benutzer Steuerelement jedoch an einer beliebigen Stelle auf einer Webseite platziert werden kann, ist es nicht möglich, im Voraus zu wissen, welche Benennungs Container die Steuerelemente enthalten.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. Um sicherzustellen, dass der ClientID Wert mit dem ID Wert übereinstimmen, legt der Code den ClientIDMode Wert auf Staticfest.To make sure that the ClientID value will be the same as the ID value, the code sets the ClientIDMode value to Static.

Im folgenden Beispiel wird das Benutzer Steuerelement gezeigt.The following example shows the user control.

Das folgende Beispiel zeigt die Inhaltsseite, die das Benutzer Steuerelement enthält.The following example shows the content page that contains the user control.

Das folgende Beispiel zeigt die Master Seite, die die Inhaltsseite enthält.The following example shows the master page that contains the content page.

Hinweise

Wenn ein Webserver Steuerelement als HTML-Element gerendert wird, wird das id-Attribut des-HTML-Elements auf den Wert der ClientID-Eigenschaft festgelegt.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. Der ClientID Wert wird häufig verwendet, um auf das HTML-Element im Client Skript zuzugreifen, indem die document.getElementById-Methode verwendet wird.The ClientID value is often used to access the HTML element in client script by using the document.getElementById method. Die ID wird auch häufig in CSS-Regeln verwendet, um Elemente anzugeben, die formatiert werden sollen.The ID is also often used in CSS rules to specify elements to style. Beispielsweise wählt die folgende CSS-Stilregel alle span Elemente aus, die den id-Attribut Wert ProductIDLabel aufweisen, und legt das background-color-Attribut auf whitefest: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 bietet mehrere Algorithmen zum Generieren des ClientID Eigenschafts Werts.ASP.NET provides multiple algorithms for how to generate the ClientID property value. Sie wählen den Algorithmus, der für ein Steuerelement verwendet werden soll, indem Sie dessen ClientIDMode-Eigenschaft festlegen.You select which algorithm to use for a control by setting its ClientIDMode property. Die Algorithmen werden durch die ClientIDMode Enumerationswerte identifiziert, die in der folgenden Tabelle aufgeführt sind.The algorithms are identified by the ClientIDMode enumeration values that are listed in the following table.

WertValue BeschreibungDescription
AutoID Der ClientID-Wert wird generiert, indem die ID-Werte der einzelnen übergeordneten Benennungscontainer mit dem ID-Wert des Steuerelements verkettet werdenThe ClientID value is generated by concatenating the ID values of each parent naming container with the ID value of the control. In Datenbindungsszenarios, in denen mehrere Instanzen eines Steuerelements gerendert werden, wird vor dem ID-Wert des Steuerelements ein inkrementierender Wert eingefügt.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. Die einzelnen Segmente werden durch einen Unterstrich () getrennt.Each segment is separated by an underscore character (). Dieser Algorithmus wurde in früheren Versionen von ASP.net als ASP.NET 4 verwendet.This algorithm was used in versions of ASP.NET earlier than ASP.NET 4.
Static Der ClientID-Wert wird auf den Wert der ID-Eigenschaft festgelegt.The ClientID value is set to the value of the ID property. Wenn es sich bei dem Steuerelement um einen Benennungscontainer handelt, ist das Steuerelement für alle enthaltenen Steuerelemente das oberste Element in der Hierarchie von Benennungscontainern.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 Dieser Algorithmus wird für Steuerelemente in datengebundenen Steuerelementen verwendet.This algorithm is used for controls that are in data-bound controls. Der ClientID-Wert wird generiert, indem der ClientID-Wert des übergeordneten Benennungscontainers mit dem ID-Wert des Steuerelements verkettet wird.The ClientID value is generated by concatenating the ClientID value of the parent naming container with the ID value of the control. Wenn es sich bei dem Steuerelement um ein datengebundenes Steuerelement handelt, das mehrere Zeilen generiert, wird der Wert des in der ClientIDRowSuffix-Eigenschaft angegebenen Datenfelds am Ende hinzugefügt.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. Für das GridView-Steuerelement können mehrere Datenfelder angegeben werden.For the GridView control, multiple data fields can be specified. Wenn die ClientIDRowSuffix-Eigenschaft leer ist, wird am Ende anstelle eines Daten Feldwerts eine sequenzielle Zahl hinzugefügt.If the ClientIDRowSuffix property is blank, a sequential number is added at the end instead of a data-field value. Die einzelnen Segmente werden durch einen Unterstrich () getrennt.Each segment is separated by an underscore character ().
Inherit Das Steuerelement erbt die ClientIDMode-Einstellung seines NamingContainer-Steuerelements.The control inherits the ClientIDMode setting of its NamingContainer control.

Der Standardwert ClientIDMode für eine Seite ist Predictable.The default value of ClientIDMode for a page is Predictable. Der Standardwert ClientIDMode für ein Steuerelement ist Inherit.The default value of ClientIDMode for a control is Inherit. Da der Standardwert für-Steuerelemente Inheritist, wird der Standard Generierungs Modus Predictable.Because the default for controls is Inherit, the default generation mode is Predictable. (Wenn Sie jedoch Visual Studio verwenden, um ein Webprojekt aus einer früheren Version in ASP.NET 4 zu konvertieren, wird die Website standardmäßig von Visual Studio automatisch auf AutoID in der Datei "Web. config" festgelegt.)(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.)

Weitere Informationen finden Sie unter Steuerelementidentifikation in Web Forms.For more information, see ASP.NET Web Server Control Identification.

Gilt für:

Siehe auch