Partilhar via

ClientIDMode Enumeração

Definição

Namespace:
System.Web.UI
Assembly:
System.Web.dll

Especifica como ASP.NET gera o ClientID para um controle que pode ser acessado no script do cliente.

public enum class ClientIDMode
public enum ClientIDMode
type ClientIDMode = 
Public Enum ClientIDMode
Herança
Object
ValueType
Enum
ClientIDMode

Campos

Nome Valor Description
Inherit 0

O controle herda a ClientIDMode configuração de seu NamingContainer controle.
AutoID 1

O ClientID valor é gerado concatenando os ID valores de cada contêiner de nomenclatura pai com o ID valor do controle. Em cenários de associação de dados em que várias instâncias de um controle são renderizadas, um valor de incremento é inserido na frente do valor do ID controle. Cada segmento é separado por um caractere de sublinhado (_). Esse algoritmo é o único disponível em versões de ASP.NET anteriores ao ASP.NET 4.
Predictable 2

Esse algoritmo é usado para controles que estão em controles associados a dados. O ClientID valor é gerado concatenando o ClientID valor do contêiner de nomenclatura pai com o ID valor do controle. Se o controle for um controle associado a dados que gera várias linhas, o valor do campo de dados especificado na ClientIDRowSuffix propriedade será adicionado no final. Para o GridView controle, vários campos de dados podem ser especificados. Se a ClientIDRowSuffix propriedade estiver em branco, um número sequencial será adicionado no final, em vez de um valor de campo de dados. Cada segmento é separado por um caractere de sublinhado (_).
Static 3

O ClientID valor é definido como o valor da ID propriedade. Se o controle for um contêiner de nomenclatura, o controle será usado como a parte superior da hierarquia de contêineres de nomenclatura para quaisquer controles que ele contenha.

Exemplos

O exemplo a seguir mostra Label os controles contidos em um ListView controle. ListView No controle, a ClientIDMode propriedade é definida como Previsível e a ClientIDRowSuffix propriedade é definida como ProductID. No script do cliente, você pode acessar uma instância específica de uma Label com base no ProductID valor da instância que você está tentando acessar.

Este exemplo cria HTML com três ProductIDLabel controles. Quando a página for executada, as IDs dos controles serão as seguintes:

  • 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>

Comentários

Você usa a ClientIDMode enumeração quando define a ClientIDMode propriedade para um controle. O valor que você atribui à ClientIDMode propriedade determina como a ClientID propriedade é gerada. O valor da ClientID propriedade é renderizado como o id atributo na marcação e é o valor que você usa para acessar o controle do script do cliente. O valor que você atribui à ClientIDMode propriedade não afeta a ID propriedade do controle do servidor, apenas o id atributo do elemento HTML correspondente.

O valor padrão de ClientIDMode uma página é Previsível. O valor padrão de ClientIDMode um controle é Inherit.

Como o padrão para controles é Herdar, o modo de geração padrão é Previsível. (No entanto, se você usar o Visual Studio para converter um projeto Web em ASP.NET 4 de uma versão anterior, o Visual Studio definirá automaticamente o padrão do site como AutoID no arquivo Web.config.)

Você pode definir o ClientIDMode valor de todas as páginas em um site definindo o elemento pages no arquivo Web.config do site. Você pode definir o ClientIDMode valor de uma página na diretiva @ Page .

Para obter mais informações, consulte ASP.NET Identificação de Controle do Servidor Web.

Aplica-se a

Confira também