DataKey Classe

Référence

Définition

Espace de noms:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Représente le ou les champs de clé primaire d’un enregistrement dans un contrôle lié aux données.

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

Héritage: Object
DataKey

Implémente: IStateManager IEquatable<DataKey>

Exemples

L’exemple de code suivant montre comment déterminer la valeur de clé primaire d’un enregistrement dans un DetailsView contrôle à l’aide de la Value propriété d’un DataKey objet.


<%@ 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>

Remarques

La DataKey classe est utilisée pour représenter la clé primaire d’un enregistrement dans un contrôle lié aux données. La clé primaire d’un enregistrement peut être composée d’un de plusieurs champs de la source de données. Bien que la DataKey classe ne soit pas une collection, elle peut stocker plusieurs valeurs de champ de clé. Les valeurs de champ clé sont remplies quand l’un des constructeurs de la DataKey classe est appelé. Vous pouvez récupérer une valeur de champ clé à partir d’un DataKey objet de la manière suivante :

Utilisez la DataKey.Item[Int32] propriété pour récupérer une valeur de champ clé à un index spécifique dans l’objet DataKey .
Utilisez la DataKey.Item[String] propriété pour récupérer une valeur de champ clé d’un champ spécifique.
Utilisez la Value propriété pour récupérer la valeur du champ de clé à l’index 0 de l’objet DataKey . Cette propriété est souvent utilisée comme raccourci pour récupérer la valeur de clé d’un enregistrement lorsque la clé primaire ne contient qu’un seul champ.
Utilisez la Values propriété pour créer un IOrderedDictionary objet qui peut être utilisé pour itérer par le biais des valeurs de champ clé.

En général, DataKey les objets sont générés automatiquement par des contrôles liés aux données lorsque la propriété du DataKeyNames contrôle est définie. Les DataKey objets contiennent les valeurs du champ ou des champs clés spécifiés dans la DataKeyNames propriété. Les contrôles liés aux données qui affichent un enregistrement unique à la fois (par exemple DetailsView , ou FormView) stockent généralement l’objet DataKey pour l’enregistrement actif affiché dans la DataKey propriété du contrôle. Les contrôles liés aux données qui affichent plusieurs enregistrements à la fois (par exemple GridView) stockent généralement les DataKey objets pour chaque enregistrement dans le contrôle d’une DataKeyArray collection. La DataKeyArray collection est ensuite stockée dans la DataKeys propriété du contrôle.

Constructeurs

DataKey(IOrderedDictionary)	Initialise une nouvelle instance de la classe DataKey à l'aide du dictionnaire de valeurs de champs clés spécifié.
DataKey(IOrderedDictionary, String[])	Initialise une nouvelle instance de la classe DataKey à l'aide du dictionnaire de valeurs de champs clés et du tableau de noms des champs spécifiés.

Propriétés

IsTrackingViewState	Obtient une valeur indiquant si l'objet DataKey effectue le suivi des modifications de son état d'affichage.
Item[Int32]	Obtient la valeur de champ clé à l'index spécifié d'un objet DataKey.
Item[String]	Obtient la valeur du champ clé avec le nom de champ spécifié d'un objet DataKey.
Value	Obtient la valeur du champ clé à l'index 0 dans l'objet DataKey.
Values	Obtient un objet IOrderedDictionary qui contient tous les champs clés de l'objet DataKey.

Méthodes

Equals(DataKey)	Détermine si le tableau DataKey spécifié est égal à la clé de données actuelle.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
LoadViewState(Object)	Charge l'état d'affichage enregistré précédemment de l'objet DataKey.
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
SaveViewState()	Enregistre l'état d'affichage actuel de l'objet DataKey.
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)
TrackViewState()	Marque le point de départ du suivi et de l'enregistrement des modifications d'état d'affichage apportées à l'objet DataKey.

Implémentations d’interfaces explicites

IStateManager.IsTrackingViewState	Obtient une valeur indiquant si l'objet DataKey effectue le suivi des modifications de son état d'affichage.
IStateManager.LoadViewState(Object)	Charge l'état d'affichage enregistré précédemment de l'objet DataKey.
IStateManager.SaveViewState()	Enregistre l'état d'affichage actuel de l'objet DataKey.
IStateManager.TrackViewState()	Marque le point de départ du suivi et de l'enregistrement des modifications d'état d'affichage apportées à l'objet DataKey.

S’applique à