DataKey Klasa

Definicja

Przedstawia pole klucza podstawowego lub pola rekordu w kontrolce powiązanej z danymi.Represents the primary key field or fields of a record in a data-bound control.

public ref class DataKey : System::Web::UI::IStateManager
public ref class DataKey : IEquatable<System::Web::UI::WebControls::DataKey ^>, System::Web::UI::IStateManager
public class DataKey : System.Web.UI.IStateManager
public class DataKey : IEquatable<System.Web.UI.WebControls.DataKey>, System.Web.UI.IStateManager
type DataKey = class
    interface IStateManager
type DataKey = class
    interface IStateManager
    interface IEquatable<DataKey>
Public Class DataKey
Implements IStateManager
Public Class DataKey
Implements IEquatable(Of DataKey), IStateManager
Dziedziczenie
DataKey
Implementuje

Przykłady

Poniższy przykład kodu demonstruje, jak określić wartość klucza podstawowego rekordu w DetailsView kontrolce przy użyciu Value właściwości DataKey obiektu.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>

Uwagi

DataKeyKlasa jest używana do reprezentowania klucza podstawowego rekordu w kontrolce powiązanej z danymi.The DataKey class is used to represent the primary key for a record in a data-bound control. Klucz podstawowy rekordu może składać się z jednego z kilku pól ze źródła danych.The primary key for a record can be composed of one of more fields from the data source. Chociaż DataKey Klasa nie jest kolekcją, może przechowywać wiele wartości pól klucza.Although the DataKey class is not a collection, it can store multiple key field values. Wartości pól klucza są wypełniane, gdy jeden z konstruktorów DataKey klasy jest wywoływany.The key field values are populated when one of the constructors for the DataKey class is called. Możesz pobrać wartość pola klucza z DataKey obiektu w następujący sposób:You can retrieve a key field value from a DataKey object in the following ways:

  • Użyj DataKey.Item[Int32] właściwości, aby pobrać wartość pola klucza z określonym indeksem w DataKey obiekcie.Use the DataKey.Item[Int32] property to retrieve a key field value at a specific index in the DataKey object.

  • Użyj DataKey.Item[String] właściwości, aby pobrać wartość pola klucza dla określonego pola.Use the DataKey.Item[String] property to retrieve a key field value of a specific field.

  • Użyj Value właściwości, aby pobrać wartość pola klucza pod indeksem 0 w DataKey obiekcie.Use the Value property to retrieve the value of the key field at index 0 in the DataKey object. Ta właściwość jest często używana jako skrót do pobrania wartości klucza rekordu, gdy klucz podstawowy zawiera tylko jedno pole.This property is often used as a shortcut to retrieve the key value of a record when the primary key contains only one field.

  • Użyj Values właściwości, aby utworzyć IOrderedDictionary obiekt, którego można użyć do iteracji wartości pól klucza.Use the Values property to create an IOrderedDictionary object that can be used to iterate through the key field values.

Ogólnie rzecz biorąc, DataKey obiekty są generowane automatycznie przez kontrolki powiązane z danymi, gdy DataKeyNames Właściwość kontrolki jest ustawiona.In general, DataKey objects are automatically generated by data-bound controls when the control's DataKeyNames property is set. DataKeyObiekty zawierają wartości pola klucza lub pól określonych we DataKeyNames właściwości.The DataKey objects contain the values of the key field or fields specified in the DataKeyNames property. Kontrolki powiązane z danymi, które wyświetlają pojedynczy rekord w danym momencie (na przykład DetailsView lub FormView ), zwykle przechowują DataKey obiekt dla bieżącego rekordu wyświetlanego we DataKey właściwości formantu.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. Formanty powiązane z danymi, które wyświetlają wiele rekordów jednocześnie (na przykład GridView ), zwykle przechowują DataKey obiekty dla każdego rekordu w kontrolce w DataKeyArray kolekcji.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. DataKeyArrayKolekcja jest następnie przechowywana we DataKeys właściwości formantu.The DataKeyArray collection is then stored in the DataKeys property of the control.

Konstruktory

DataKey(IOrderedDictionary)

Inicjuje nowe wystąpienie DataKey klasy przy użyciu określonego słownika wartości pola klucza.Initializes a new instance of the DataKey class using the specified dictionary of key field values.

DataKey(IOrderedDictionary, String[])

Inicjuje nowe wystąpienie DataKey klasy przy użyciu określonego słownika wartości pól klucza i tablicy nazw pól.Initializes a new instance of the DataKey class using the specified dictionary of key field values and array of field names.

Właściwości

IsTrackingViewState

Pobiera wartość wskazującą, czy DataKey obiekt śledzi zmiany stanu widoku.Gets a value indicating whether the DataKey object is tracking its view-state changes.

Item[Int32]

Pobiera wartość pola klucza w określonym indeksie z DataKey obiektu.Gets the value of the key field at the specified index from a DataKey object.

Item[String]

Pobiera wartość pola klucza z określoną nazwą pola z DataKey obiektu.Gets the value of the key field with the specified field name from a DataKey object.

Value

Pobiera wartość pola klucza pod indeksem 0 w DataKey obiekcie.Gets the value of the key field at index 0 in the DataKey object.

Values

Pobiera IOrderedDictionary obiekt, który zawiera każde pole klucza w DataKey obiekcie.Gets an IOrderedDictionary object that contains every key field in the DataKey object.

Metody

Equals(DataKey)

Określa, czy określona DataKey Tablica jest równa bieżącemu kluczowi danych.Determines whether the specified DataKey array is equal to the current data key.

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.Determines whether the specified object is equal to the current object.

(Odziedziczone po Object)
GetHashCode()

Służy jako domyślna funkcja skrótu.Serves as the default hash function.

(Odziedziczone po Object)
GetType()

Pobiera Type bieżące wystąpienie.Gets the Type of the current instance.

(Odziedziczone po Object)
LoadViewState(Object)

Ładuje wcześniej zapisany stan widoku DataKey obiektu.Loads the previously saved view state of the DataKey object.

MemberwiseClone()

Tworzy skróconą kopię bieżącego elementu Object .Creates a shallow copy of the current Object.

(Odziedziczone po Object)
SaveViewState()

Zapisuje bieżący stan widoku DataKey obiektu.Saves the current view state of the DataKey object.

ToString()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)
TrackViewState()

Oznacza punkt początkowy, od którego ma zostać rozpoczęte śledzenie i zapisywanie zmian stanu widoku w DataKey obiekcie.Marks the starting point at which to begin tracking and saving view-state changes to the DataKey object.

Jawne implementacje interfejsu

IStateManager.IsTrackingViewState

Pobiera wartość wskazującą, czy DataKey obiekt śledzi zmiany stanu widoku.Gets a value indicating whether the DataKey object is tracking its view-state changes.

IStateManager.LoadViewState(Object)

Ładuje wcześniej zapisany stan widoku DataKey obiektu.Loads the previously saved view state of the DataKey object.

IStateManager.SaveViewState()

Zapisuje bieżący stan widoku DataKey obiektu.Saves the current view state of the DataKey object.

IStateManager.TrackViewState()

Oznacza punkt początkowy, od którego ma zostać rozpoczęte śledzenie i zapisywanie zmian stanu widoku w DataKey obiekcie.Marks the starting point at which to begin tracking and saving view-state changes to the DataKey object.

Dotyczy

Zobacz też