Exporter (0) Imprimer
Développer tout

DataKey, classe

Remarque : cette classe est nouvelle dans le .NET Framework version 2.0.

Représente le ou les champs clés primaires d'un enregistrement dans un contrôle lié aux données.

Espace de noms : System.Web.UI.WebControls
Assembly : System.Web (dans system.web.dll)

public class DataKey : IStateManager
public class DataKey implements IStateManager
public class DataKey implements IStateManager

La classe DataKey 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 ou plusieurs champs de la source de données. Bien que la classe DataKey ne soit pas une collection, elle peut stocker plusieurs valeurs de champs clés. Les valeurs de champs clés sont remplies lorsque l'un des constructeurs de la classe DataKey est appelé. Vous pouvez récupérer une valeur de champ clé d'un objet DataKey selon une des manières suivantes :

  • Utilisez la propriété DataKey.Item(Int32) pour récupérer une valeur de champ clé à un index spécifique dans l'objet DataKey.

  • Utilisez la propriété DataKey.Item(String) pour récupérer une valeur de champ clé d'un champ spécifique.

  • Utilisez la propriété Value pour récupérer la valeur du champ clé à l'index 0 dans 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 contient un seul champ.

  • Utilisez la propriété Values pour créer un objet IOrderedDictionary qui peut être utilisé pour parcourir les valeurs de champs clés.

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

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


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

<script runat="server">

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

<html>

  <body>
    <form 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>


  • AspNetHostingPermission  pour opérer dans un environnement hébergé. Valeur de demande : LinkDemand ; valeur d'autorisation : Minimal
  • AspNetHostingPermission  pour opérer dans un environnement hébergé. Valeur de demande : InheritanceDemand ; valeur d'autorisation : Minimal

System.Object
  System.Web.UI.WebControls.DataKey

Les membres statiques publics (Shared en Visual Basic) de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Édition Media Center, Windows XP Professionnel Édition x64, Windows XP SP2, Windows XP Starter Edition

Le .NET Framework ne prend pas en charge toutes les versions de chaque plate-forme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise.

.NET Framework

Prise en charge dans : 2.0

Ajouts de la communauté

AJOUTER
Afficher:
© 2015 Microsoft