DataKey Klasse

Definition

Stellt das Primärschlüsselfeld oder Felder eines Datensatzes in einem datengebundenen Steuerelement dar.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
Vererbung
DataKey
Implementiert

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie der Primärschlüssel Wert eines Datensatzes in einem DetailsView -Steuerelement Value mithilfe der- DataKey Eigenschaft eines-Objekts bestimmt wird.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>

Hinweise

Die DataKey -Klasse wird verwendet, um den Primärschlüssel für einen Datensatz in einem Daten gebundenen Steuerelement darzustellen.The DataKey class is used to represent the primary key for a record in a data-bound control. Der Primärschlüssel für einen Datensatz kann aus einem der weiteren Felder aus der Datenquelle bestehen.The primary key for a record can be composed of one of more fields from the data source. Obwohl es DataKey sich bei der-Klasse nicht um eine Auflistung handelt, können mehrere Schlüssel Feldwerte gespeichert werden.Although the DataKey class is not a collection, it can store multiple key field values. Die Schlüssel Feldwerte werden aufgefüllt, wenn einer der Konstruktoren für die DataKey Klasse aufgerufen wird.The key field values are populated when one of the constructors for the DataKey class is called. Sie können einen Schlüssel Feldwert wie folgt aus DataKey einem-Objekt abrufen:You can retrieve a key field value from a DataKey object in the following ways:

  • Verwenden Sie DataKey.Item[Int32] die-Eigenschaft, um einen Schlüssel Feldwert an einem bestimmten Index DataKey im-Objekt abzurufen.Use the DataKey.Item[Int32] property to retrieve a key field value at a specific index in the DataKey object.

  • Verwenden Sie DataKey.Item[String] die-Eigenschaft, um einen Schlüssel Feldwert eines bestimmten Felds abzurufen.Use the DataKey.Item[String] property to retrieve a key field value of a specific field.

  • Verwenden Sie Value die-Eigenschaft, um den Wert des Schlüssel Felds am Index 0 DataKey im-Objekt abzurufen.Use the Value property to retrieve the value of the key field at index 0 in the DataKey object. Diese Eigenschaft wird häufig als Verknüpfung zum Abrufen des Schlüssel Werts eines Datensatzes verwendet, wenn der Primärschlüssel nur ein Feld enthält.This property is often used as a shortcut to retrieve the key value of a record when the primary key contains only one field.

  • Verwenden Sie Values die-Eigenschaft, IOrderedDictionary um ein Objekt zu erstellen, das zum Durchlaufen der Schlüssel Feldwerte verwendet werden kann.Use the Values property to create an IOrderedDictionary object that can be used to iterate through the key field values.

Im Allgemeinen werden DataKey -Objekte automatisch durch Daten gebundene Steuerelemente generiert, wenn die- DataKeyNames Eigenschaft des-Steuer Elements festgelegt wird.In general, DataKey objects are automatically generated by data-bound controls when the control's DataKeyNames property is set. Die DataKey -Objekte enthalten die Werte des Schlüssel Felds oder der Felder, die DataKeyNames in der-Eigenschaft angegeben sind.The DataKey objects contain the values of the key field or fields specified in the DataKeyNames property. Daten gebundene Steuerelemente, die jeweils einen einzelnen Datensatz anzeigen ( DetailsView z. b. oder FormView), speichern DataKey im Allgemeinen das-Objekt für den aktuellen DataKey Datensatz, der in der-Eigenschaft des-Steuer Elements angezeigt wird.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. Daten gebundene Steuerelemente, die mehrere Datensätze gleichzeitig anzeigen (z GridView. b.) DataKey , speichern im Allgemeinen die Objekte für jeden Datensatz DataKeyArray im-Steuerelement in einer Auflistung.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. Die DataKeyArray Auflistung wird dann in der DataKeys -Eigenschaft des-Steuer Elements gespeichert.The DataKeyArray collection is then stored in the DataKeys property of the control.

Konstruktoren

DataKey(IOrderedDictionary)

Initialisiert eine neue Instanz der DataKey-Klasse unter Verwendung des angegebenen Wörterbuchs der Schlüsselfeldwerte.Initializes a new instance of the DataKey class using the specified dictionary of key field values.

DataKey(IOrderedDictionary, String[])

Initialisiert eine neue Instanz der DataKey-Klasse unter Verwendung des angegebenen Wörterbuchs der Schlüsselfeldwerte und des angegebenen Feldnamenarrays.Initializes a new instance of the DataKey class using the specified dictionary of key field values and array of field names.

Eigenschaften

IsTrackingViewState

Ruft einen Wert ab, der angibt, ob das DataKey-Objekt die Änderungen des Ansichtszustands nachverfolgt.Gets a value indicating whether the DataKey object is tracking its view-state changes.

Item[Int32]

Ruft den Wert des Schlüsselfelds am angegebenen Index aus einem DataKey-Objekt ab.Gets the value of the key field at the specified index from a DataKey object.

Item[String]

Ruft den Wert des Schlüsselfelds mit dem angegebenen Feldnamen aus einem DataKey-Objekt ab.Gets the value of the key field with the specified field name from a DataKey object.

Value

Ruft den Wert des Schlüsselfelds am Index 0 (null) im DataKey-Objekt ab.Gets the value of the key field at index 0 in the DataKey object.

Values

Ruft ein IOrderedDictionary-Objekt ab, das jedes Schlüsselfeld im DataKey-Objekt enthält.Gets an IOrderedDictionary object that contains every key field in the DataKey object.

Methoden

Equals(DataKey)

Bestimmt, ob das angegebene DataKey-Array und der aktuelle Datenschlüssel gleich sind.Determines whether the specified DataKey array is equal to the current data key.

Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
LoadViewState(Object)

Lädt den zuvor gespeicherten Ansichtszustand des DataKey-Objekts.Loads the previously saved view state of the DataKey object.

MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
SaveViewState()

Speichert den aktuellen Ansichtszustand des DataKey-Objekts.Saves the current view state of the DataKey object.

ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)
TrackViewState()

Markiert den Ausgangspunkt, an dem die Nachverfolgung und das Speichern der Ansichtszustandsänderungen des DataKey-Objekts beginnen soll.Marks the starting point at which to begin tracking and saving view-state changes to the DataKey object.

Explizite Schnittstellenimplementierungen

IStateManager.IsTrackingViewState

Ruft einen Wert ab, der angibt, ob das DataKey-Objekt die Änderungen des Ansichtszustands nachverfolgt.Gets a value indicating whether the DataKey object is tracking its view-state changes.

IStateManager.LoadViewState(Object)

Lädt den zuvor gespeicherten Ansichtszustand des DataKey-Objekts.Loads the previously saved view state of the DataKey object.

IStateManager.SaveViewState()

Speichert den aktuellen Ansichtszustand des DataKey-Objekts.Saves the current view state of the DataKey object.

IStateManager.TrackViewState()

Markiert den Ausgangspunkt, an dem die Nachverfolgung und das Speichern der Ansichtszustandsänderungen des DataKey-Objekts beginnen soll.Marks the starting point at which to begin tracking and saving view-state changes to the DataKey object.

Gilt für:

Siehe auch