DataKey DataKey DataKey DataKey Class

Definición

Representa el campo o campos clave principales de un registro de un control enlazado a datos.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
Herencia
DataKeyDataKeyDataKeyDataKey
Implementaciones

Ejemplos

En el ejemplo de código siguiente se muestra cómo determinar el valor de clave principal de un DetailsView registro de un Value control mediante la DataKey propiedad de un 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>

Comentarios

La DataKey clase se utiliza para representar la clave principal de un registro de un control enlazado a datos.The DataKey class is used to represent the primary key for a record in a data-bound control. La clave principal de un registro puede estar formada por uno o varios campos del origen de datos.The primary key for a record can be composed of one of more fields from the data source. Aunque la DataKey clase no es una colección, puede almacenar varios valores de campo clave.Although the DataKey class is not a collection, it can store multiple key field values. Los valores de campo de clave se rellenan cuando se llama a DataKey uno de los constructores para la clase.The key field values are populated when one of the constructors for the DataKey class is called. Puede recuperar un valor de campo de clave de DataKey un objeto de las siguientes maneras:You can retrieve a key field value from a DataKey object in the following ways:

  • Utilice la DataKey.Item[Int32] propiedad para recuperar un valor de campo de clave en un índice DataKey específico del objeto.Use the DataKey.Item[Int32] property to retrieve a key field value at a specific index in the DataKey object.

  • Use la DataKey.Item[String] propiedad para recuperar un valor de campo de clave de un campo específico.Use the DataKey.Item[String] property to retrieve a key field value of a specific field.

  • Utilice la Value propiedad para recuperar el valor del campo de clave en el DataKey índice 0 del objeto.Use the Value property to retrieve the value of the key field at index 0 in the DataKey object. Esta propiedad se utiliza a menudo como método abreviado para recuperar el valor de clave de un registro cuando la clave principal contiene un solo 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.

  • Utilice la Values propiedad para crear un IOrderedDictionary objeto que se puede usar para recorrer en iteración los valores de campo de clave.Use the Values property to create an IOrderedDictionary object that can be used to iterate through the key field values.

En general, DataKey los controles enlazados a datos generan automáticamente los objetos cuando se establece DataKeyNames la propiedad del control.In general, DataKey objects are automatically generated by data-bound controls when the control's DataKeyNames property is set. Los DataKey objetos contienen los valores del campo o los campos de clave especificados DataKeyNames en la propiedad.The DataKey objects contain the values of the key field or fields specified in the DataKeyNames property. Los controles enlazados a datos que muestran DetailsView un único registro cada vez (como o FormView) suelen almacenar el DataKey objeto del registro actual que se muestra en la DataKey propiedad del control.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. Los controles enlazados a datos que muestran varios registros a la vez ( GridViewcomo) suelen almacenar DataKey los objetos de cada registro del control en una DataKeyArray colección.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. A DataKeyArray continuación, la colección se almacena DataKeys en la propiedad del control.The DataKeyArray collection is then stored in the DataKeys property of the control.

Constructores

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

Inicializa una instancia nueva de la clase DataKey utilizando el diccionario especificado de valores de campo clave.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 una instancia nueva de la clase DataKey utilizando el diccionario de valores de campo clave y matriz de nombres de campo especificados.Initializes a new instance of the DataKey class using the specified dictionary of key field values and array of field names.

Propiedades

IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

Obtiene un valor que indica si el objeto DataKey realiza el seguimiento de los cambios de su estado de vista.Gets a value indicating whether the DataKey object is tracking its view-state changes.

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

Obtiene el valor del campo clave situado en el índice especificado de un 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]

Obtiene el valor del campo clave con el nombre de campo especificado de un objeto DataKey.Gets the value of the key field with the specified field name from a DataKey object.

Value Value Value Value

Obtiene el valor del campo clave situado en el índice 0 del objeto DataKey.Gets the value of the key field at index 0 in the DataKey object.

Values Values Values Values

Obtiene un objeto IOrderedDictionary que contiene todos los campos clave del 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 si la matriz especificada de objetos DataKey equivale a la clave de datos actual.Determines whether the specified DataKey array is equal to the current data key.

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

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

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

Sirve como la función hash predeterminada.Serves as the default hash function.

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

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

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

Carga el estado de vista guardado previamente del objeto DataKey.Loads the previously saved view state of the DataKey object.

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

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

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

Guarda el estado de vista actual del objeto DataKey.Saves the current view state of the DataKey object.

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

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

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

Marca el punto de inicio en que se debe empezar a realizar el seguimiento y a guardar los cambios del objeto DataKey.Marks the starting point at which to begin tracking and saving view-state changes to the DataKey object.

Implementaciones de interfaz explícitas

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

Obtiene un valor que indica si el objeto DataKey realiza el seguimiento de los cambios de su estado de vista.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)

Carga el estado de vista guardado previamente del objeto DataKey.Loads the previously saved view state of the DataKey object.

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

Guarda el estado de vista actual del objeto DataKey.Saves the current view state of the DataKey object.

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

Marca el punto de inicio en que se debe empezar a realizar el seguimiento y a guardar los cambios del objeto DataKey.Marks the starting point at which to begin tracking and saving view-state changes to the DataKey object.

Se aplica a

Consulte también: