Control.ClientID Proprietà

  • Riferimento

Definizione

Spazio dei nomi:
System.Web.UI
Assembly:
System.Web.dll

Ottiene l'ID di controllo per il markup HTML generato da ASP.NET.

public:
 virtual property System::String ^ ClientID { System::String ^ get(); };
[System.ComponentModel.Browsable(false)]
public virtual string ClientID { get; }
[<System.ComponentModel.Browsable(false)>]
member this.ClientID : string
Public Overridable ReadOnly Property ClientID As String

Valore della proprietà

String

ID di controllo per il markup HTML generato da ASP.NET.

Attributi
BrowsableAttribute

Esempio

Gli esempi seguenti mostrano un controllo utente Web che si trova all'interno di una pagina del contenuto per una pagina master. Il controllo utente contiene un DropDownList controllo e un Label controllo. Il testo visualizzato nel Label controllo è determinato dal valore selezionato dall'utente dal DropDownList controllo. Il valore di testo viene impostato tramite script client in modo che la pagina Web non deve eseguire il postback al server per impostare questo valore. Per ottenere un riferimento all'elemento HTML sottoposto a rendering per il Label controllo nello script client, è necessario conoscere il valore della proprietà del ClientID controllo. Tuttavia, poiché il controllo utente può essere inserito ovunque in una pagina Web, è impossibile sapere in anticipo quali contenitori di denominazione conterrà i controlli. Per assicurarsi che il ClientID valore sia uguale ID al valore, il codice imposta il ClientIDMode valore su Static.

Nell'esempio seguente viene illustrato il controllo utente.

<%@ Control AutoEventWireup="true" %>

<script type="text/javascript">
  var seasonalSports = new Array("None selected",
                                 "Tennis",
                                 "Volleyball",
                                 "Baseball",
                                 "Skiing");

  function DisplaySport(x) {
      document.getElementById("SelectedSport").innerHTML
      = seasonalSports[x];
  }    
</script>

<asp:DropDownList ID="DropDownList1" runat="server" 
                  onchange="DisplaySport(this.selectedIndex);">
  <asp:ListItem Value="Select a season"></asp:ListItem>
  <asp:ListItem Value="Spring"></asp:ListItem>
  <asp:ListItem Value="Summer"></asp:ListItem>
  <asp:ListItem Value="Autumn"></asp:ListItem>
  <asp:ListItem Value="Winter"></asp:ListItem>
</asp:DropDownList>
<br />
<asp:Label ID="SelectedSport" runat="server" ClientIDMode="Static">
</asp:Label>

Nell'esempio seguente viene illustrata la pagina del contenuto contenente il controllo utente.

<%@ Page Title="" MasterPageFile="~/Seasons.master" AutoEventWireup="true" %>

<%@ Register Src="Seasons.ascx" TagName="Seasons" TagPrefix="uc1" %>
<asp:Content ID="Content1" ContentPlaceHolderID="head" runat="Server">
</asp:Content>
<asp:Content ID="Content2" ContentPlaceHolderID="ContentPlaceHolder1" runat="Server">
  <uc1:Seasons ID="Seasons1" runat="server" />
</asp:Content>

Nell'esempio seguente viene illustrata la pagina master contenente la pagina del contenuto.

<%@ Master AutoEventWireup="true" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
    <asp:ContentPlaceHolder id="head" runat="server">
    </asp:ContentPlaceHolder>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:ContentPlaceHolder id="ContentPlaceHolder1" runat="server">
        
        </asp:ContentPlaceHolder>
    </div>
    </form>
</body>
</html>

Commenti

Quando viene eseguito il rendering di un controllo server Web come elemento HTML, l'attributo id dell'elemento HTML viene impostato sul valore della ClientID proprietà. Il ClientID valore viene spesso usato per accedere all'elemento HTML nello script client usando il document.getElementById metodo . L'ID viene spesso usato anche nelle regole CSS per specificare elementi per lo stile. Ad esempio, la regola di stile CSS seguente seleziona tutti gli span elementi con il valore dell'attributo e ProductIDLabel imposta background-color l'attributo id su white:

span#ProductIDLabel { background-color: white; }

ASP.NET fornisce più algoritmi per come generare il valore della ClientID proprietà. Selezionare l'algoritmo da usare per un controllo impostandone la ClientIDMode proprietà. Gli algoritmi vengono identificati dai ClientIDMode valori di enumerazione elencati nella tabella seguente.

valore Descrizione
AutoID Il valore ClientID viene generato tramite la concatenazione dei valori ID di ogni contenitore di denominazione padre con il valore ID del controllo. In scenari di associazione a dati in cui viene eseguito il rendering di più istanze di un controllo, viene inserito un valore incrementale davanti al valore ID del controllo. Ogni segmento è separato da un carattere di sottolineatura (_). Questo algoritmo è stato usato nelle versioni di ASP.NET precedenti a ASP.NET 4.
Static Il valore ClientID è impostato sul valore della proprietà ID. Se il controllo è un contenitore di denominazione, il controllo viene utilizzato come elemento principale della gerarchia di contenitori di denominazione per qualsiasi controllo contenuto.
Predictable Questo algoritmo viene utilizzato per controlli inclusi in controlli associati a dati. Il valore ClientID viene generato tramite la concatenazione del valore ClientID del contenitore di denominazione padre con il valore ID del controllo. Se il controllo è un controllo associato a dati che genera più righe, il valore del campo dati specificato nella proprietà ClientIDRowSuffix viene aggiunto alla fine. Per il controllo GridView, è possibile specificare più campi dati. Se la ClientIDRowSuffix proprietà è vuota, viene aggiunto un numero sequenziale alla fine anziché un valore di campo dati. Ogni segmento è separato da un carattere di sottolineatura (_).
Inherit Il controllo eredita l'impostazione ClientIDMode del relativo controllo NamingContainer.

Il valore predefinito di ClientIDMode per una pagina è Predictable. Il valore predefinito di ClientIDMode per un controllo è Inherit. Poiché il valore predefinito per i controlli è Inherit, la modalità di generazione predefinita è Predictable. Se tuttavia si usa Visual Studio per convertire un progetto Web in ASP.NET 4 da una versione precedente, Visual Studio imposta automaticamente il valore predefinito AutoID del sito nel file Web.config.

Per altre informazioni, vedere ASP.NET Web Server Control Identification (Identificazione del controllo server Web ASP.NET).

Si applica a

Vedi anche