DataKey Třída

Reference

Definice

Obor názvů:: System.Web.UI.WebControls

Sestavení:: System.Web.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Představuje pole primárního klíče nebo pole záznamu v ovládacím prvku vázaném na data.

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

Dědičnost: Object
DataKey

Implementuje: IStateManager IEquatable<DataKey>

Příklady

Následující příklad kódu ukazuje, jak určit hodnotu primárního klíče záznamu v ovládacím DetailsView prvku pomocí Value vlastnosti objektu DataKey .


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

Poznámky

Třída DataKey se používá k reprezentaci primárního klíče záznamu v ovládacím prvku vázaném na data. Primární klíč záznamu se může skládat z jednoho z více polí ze zdroje dat. DataKey I když třída není kolekcí, může uložit více hodnot polí klíče. Hodnoty polí klíče jsou naplněny, když je volána jedna z konstruktorů pro DataKey třídu. Hodnotu pole klíče můžete z objektu DataKey načíst následujícími způsoby:

DataKey.Item[Int32] Vlastnost slouží k načtení hodnoty pole klíče v určitém indexu v objektuDataKey.
DataKey.Item[String] Vlastnost slouží k načtení hodnoty pole klíče konkrétního pole.
Value Pomocí vlastnosti načtěte hodnotu pole klíče v indexu 0 v objektuDataKey. Tato vlastnost se často používá jako zástupce k načtení hodnoty klíče záznamu, pokud primární klíč obsahuje pouze jedno pole.
Values Pomocí vlastnosti vytvořte IOrderedDictionary objekt, který lze použít k iteraci prostřednictvím hodnot polí klíče.

Obecně platí, že DataKey objekty jsou automaticky generovány ovládacími prvky vázané na data při nastavení vlastnosti ovládacího prvku DataKeyNames . Objekty DataKey obsahují hodnoty pole klíče nebo polí zadaných DataKeyNames ve vlastnosti. Ovládací prvky vázané na data, které zobrazují jeden záznam najednou (například nebo DetailsView FormView) obecně ukládají DataKey objekt pro aktuální záznam zobrazený ve DataKey vlastnosti ovládacího prvku. Ovládací prvky vázané na data, které zobrazují více záznamů najednou (například GridView) obecně ukládají DataKey objekty pro každý záznam v ovládacím prvku v kolekci DataKeyArray . Kolekce DataKeyArray se pak uloží ve DataKeys vlastnosti ovládacího prvku.

Konstruktory

DataKey(IOrderedDictionary)	Inicializuje novou instanci DataKey třídy pomocí zadaného slovníku hodnot klíčových polí.
DataKey(IOrderedDictionary, String[])	Inicializuje novou instanci DataKey třídy pomocí zadaného slovníku hodnot klíčových polí a pole názvů polí.

Vlastnosti

IsTrackingViewState	Získá hodnotu označující, zda DataKey objekt sleduje své změny stavu zobrazení.
Item[Int32]	Získá hodnotu pole klíče v zadaném indexu z objektu DataKey .
Item[String]	Získá hodnotu pole klíče se zadaným názvem pole z objektu DataKey .
Value	Získá hodnotu pole klíče v indexu 0 v objektu DataKey .
Values	IOrderedDictionary Získá objekt, který obsahuje každé pole klíče v objektuDataKey.

Metody

Equals(DataKey)	Určuje, zda se zadané DataKey pole rovná aktuálnímu datovému klíči.
Equals(Object)	Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí funkce hash. (Zděděno od Object)
GetType()	Type Získá aktuální instanci. (Zděděno od Object)
LoadViewState(Object)	Načte dříve uložený stav zobrazení objektu DataKey .
MemberwiseClone()	Vytvoří použádnou kopii aktuálního souboru Object. (Zděděno od Object)
SaveViewState()	Uloží aktuální stav zobrazení objektu DataKey .
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)
TrackViewState()	Označí výchozí bod, ve kterém chcete začít sledovat a ukládat změny stavu zobrazení objektu DataKey .

Explicitní implementace rozhraní

IStateManager.IsTrackingViewState	Získá hodnotu označující, zda DataKey objekt sleduje své změny stavu zobrazení.
IStateManager.LoadViewState(Object)	Načte dříve uložený stav zobrazení objektu DataKey .
IStateManager.SaveViewState()	Uloží aktuální stav zobrazení objektu DataKey .
IStateManager.TrackViewState()	Označí výchozí bod, ve kterém chcete začít sledovat a ukládat změny stavu zobrazení objektu DataKey .

Platí pro