DataKey DataKey DataKey DataKey Class

Definição

Representa o(s) campo(s) de chave primária de um registro em um controle com associação de dados.Represents the primary key field or fields of a record in a data-bound control.

public ref class DataKey : IEquatable<System::Web::UI::WebControls::DataKey ^>, System::Web::UI::IStateManager
public class DataKey : IEquatable<System.Web.UI.WebControls.DataKey>, System.Web.UI.IStateManager
type DataKey = class
    interface IStateManager
    interface IEquatable<DataKey>
Public Class DataKey
Implements IEquatable(Of DataKey), IStateManager
Herança
DataKeyDataKeyDataKeyDataKey
Implementações

Exemplos

O exemplo de código a seguir demonstra como determinar o valor da chave primária de um registro DetailsView em um controle Value usando a propriedade DataKey de um objeto.The following code example demonstrates how to determine the primary key value of a record in a DetailsView control using the Value property of a DataKey object.


<%@ Page language="C#" %>

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

  void CustomerDetailsView_DataBound(Object sender, EventArgs e)
  {
    // Get the DataKey object for the current record.
    DataKey key = CustomerDetailsView.DataKey;
    
    // Display the value of the key field.
    MessageLabel.Text = "The key field value for the displayed record is " + 
      key.Value.ToString() + ".";
  }
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >

  <head runat="server">
    <title>DataKey Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>DataKey Example</h3>
                       
        <asp:detailsview id="CustomerDetailsView"
          datasourceid="DetailsViewSource"
          autogeneraterows="true"
          datakeynames="CustomerID"  
          allowpaging="true"
          ondatabound="CustomerDetailsView_DataBound" 
          runat="server">
            
        </asp:detailsview>
        
        <br/>
        
        <asp:label id="MessageLabel"
          forecolor="Red"
          runat="server"/>
            
        <!-- This example uses Microsoft SQL Server and connects  -->
        <!-- to the Northwind sample database. Use an ASP.NET     -->
        <!-- expression to retrieve the connection string value   -->
        <!-- from the Web.config file.                            -->
        <asp:sqldatasource id="DetailsViewSource"
          selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
          connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
          runat="server"/>
            
      </form>
  </body>
</html>


<%@ Page language="VB" %>

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

  Sub CustomerDetailsView_DataBound(ByVal sender As Object, ByVal e As EventArgs) Handles CustomerDetailsView.DataBound

    ' Get the DataKey object for the current record.
    Dim key As DataKey = CustomerDetailsView.DataKey
    
    ' Display the value of the key field.
    MessageLabel.Text = "The key field value for the displayed record is " & _
      key.Value.ToString() & "."
    
  End Sub
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >

  <head runat="server">
    <title>DataKey Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>DataKey Example</h3>
                       
        <asp:detailsview id="CustomerDetailsView"
          datasourceid="DetailsViewSource"
          autogeneraterows="true"
          datakeynames="CustomerID"  
          allowpaging="true"
          runat="server">
            
        </asp:detailsview>
        
        <br/>
        
        <asp:label id="MessageLabel"
          forecolor="Red"
          runat="server"/>
            
        <!-- This example uses Microsoft SQL Server and connects  -->
        <!-- to the Northwind sample database. Use an ASP.NET     -->
        <!-- expression to retrieve the connection string value   -->
        <!-- from the Web.config file.                            -->
        <asp:sqldatasource id="DetailsViewSource"
          selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
          connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
          runat="server"/>
            
      </form>
  </body>
</html>

Comentários

A DataKey classe é usada para representar a chave primária para um registro em um controle associado a dados.The DataKey class is used to represent the primary key for a record in a data-bound control. A chave primária de um registro pode ser composta de um ou mais campos da fonte de dados.The primary key for a record can be composed of one of more fields from the data source. Embora a DataKey classe não seja uma coleção, ela pode armazenar vários valores de campo de chave.Although the DataKey class is not a collection, it can store multiple key field values. Os valores de campo de chave são populados quando um dos construtores DataKey para a classe é chamado.The key field values are populated when one of the constructors for the DataKey class is called. Você pode recuperar um valor de campo de chave DataKey de um objeto das seguintes maneiras:You can retrieve a key field value from a DataKey object in the following ways:

  • Use a DataKey.Item[Int32] propriedade para recuperar um valor de campo de chave em um índice específico DataKey no objeto.Use the DataKey.Item[Int32] property to retrieve a key field value at a specific index in the DataKey object.

  • Use a DataKey.Item[String] propriedade para recuperar um valor de campo de chave de um campo específico.Use the DataKey.Item[String] property to retrieve a key field value of a specific field.

  • Use a Value propriedade para recuperar o valor do campo de chave no índice 0 DataKey no objeto.Use the Value property to retrieve the value of the key field at index 0 in the DataKey object. Essa propriedade é geralmente usada como um atalho para recuperar o valor de chave de um registro quando a chave primária contém apenas um campo.This property is often used as a shortcut to retrieve the key value of a record when the primary key contains only one field.

  • Use a Values propriedade para criar um IOrderedDictionary objeto que pode ser usado para iterar pelos valores de campo de chave.Use the Values property to create an IOrderedDictionary object that can be used to iterate through the key field values.

Em geral, DataKey os objetos são gerados automaticamente por controles vinculados a dados quando a DataKeyNames Propriedade do controle é definida.In general, DataKey objects are automatically generated by data-bound controls when the control's DataKeyNames property is set. Os DataKey objetos contêm os valores do campo de chave ou campos especificados DataKeyNames na propriedade.The DataKey objects contain the values of the key field or fields specified in the DataKeyNames property. Os controles vinculados a dados que exibem um único registro por vez ( DetailsView como FormViewou) geralmente armazenam o DataKey DataKey objeto para o registro atual exibido na Propriedade do controle.Data-bound controls that display a single record at a time (such as DetailsView or FormView) generally store the DataKey object for the current record displayed in the DataKey property of the control. Os controles vinculados a dados que exibem vários registros por vez ( GridViewcomo) geralmente armazenam os DataKey objetos para cada registro no controle em DataKeyArray uma coleção.Data-bound controls that display multiple records at a time (such as GridView) generally store the DataKey objects for each record in the control in a DataKeyArray collection. Em DataKeyArray seguida, a coleção é armazenada DataKeys na Propriedade do controle.The DataKeyArray collection is then stored in the DataKeys property of the control.

Construtores

DataKey(IOrderedDictionary) DataKey(IOrderedDictionary) DataKey(IOrderedDictionary) DataKey(IOrderedDictionary)

Inicializa uma nova instância da classe DataKey usando o dicionário especificado de valores de campo de chave.Initializes a new instance of the DataKey class using the specified dictionary of key field values.

DataKey(IOrderedDictionary, String[]) DataKey(IOrderedDictionary, String[]) DataKey(IOrderedDictionary, String[]) DataKey(IOrderedDictionary, String[])

Inicializa uma nova instância da classe DataKey usando o dicionário especificado de valores de campo de chave e uma matriz de nomes de campo.Initializes a new instance of the DataKey class using the specified dictionary of key field values and array of field names.

Propriedades

IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

Obtém um valor que indica se o objeto DataKey está controlando suas alterações de estado de exibição.Gets a value indicating whether the DataKey object is tracking its view-state changes.

Item[Int32] Item[Int32] Item[Int32] Item[Int32]

Obtém o valor do campo de chave no índice especificado de um objeto DataKey.Gets the value of the key field at the specified index from a DataKey object.

Item[String] Item[String] Item[String] Item[String]

Obtém o valor do campo de chave com o nome do campo especificado de um objeto DataKey.Gets the value of the key field with the specified field name from a DataKey object.

Value Value Value Value

Obtém o valor do campo de chave no índice 0 no objeto DataKey.Gets the value of the key field at index 0 in the DataKey object.

Values Values Values Values

Obtém um objeto IOrderedDictionary que contém todos os campos de chave no objeto DataKey.Gets an IOrderedDictionary object that contains every key field in the DataKey object.

Métodos

Equals(DataKey) Equals(DataKey) Equals(DataKey) Equals(DataKey)

Determina se a DataKey especificada é igual à chave de dados atual.Determines whether the specified DataKey array is equal to the current data key.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Inherited from Object)
LoadViewState(Object) LoadViewState(Object) LoadViewState(Object) LoadViewState(Object)

Carrega o estado de exibição salvo anteriormente do objeto DataKey.Loads the previously saved view state of the DataKey object.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Inherited from Object)
SaveViewState() SaveViewState() SaveViewState() SaveViewState()

Salva o estado de exibição atual do objeto DataKey.Saves the current view state of the DataKey object.

ToString() ToString() ToString() ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Inherited from Object)
TrackViewState() TrackViewState() TrackViewState() TrackViewState()

Marca o ponto inicial no qual começar a acompanhar e salvar as alterações de estado de exibição no objeto DataKey.Marks the starting point at which to begin tracking and saving view-state changes to the DataKey object.

Implantações explícitas de interface

IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState

Obtém um valor que indica se o objeto DataKey está controlando suas alterações de estado de exibição.Gets a value indicating whether the DataKey object is tracking its view-state changes.

IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object)

Carrega o estado de exibição salvo anteriormente do objeto DataKey.Loads the previously saved view state of the DataKey object.

IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState()

Salva o estado de exibição atual do objeto DataKey.Saves the current view state of the DataKey object.

IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState()

Marca o ponto inicial no qual começar a acompanhar e salvar as alterações de estado de exibição no objeto DataKey.Marks the starting point at which to begin tracking and saving view-state changes to the DataKey object.

Aplica-se a

Veja também