DataKey DataKey DataKey DataKey Class

Определение

Представляет поле первичного ключа или поля записи в элементе управления, привязанном к данным.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
Наследование
DataKeyDataKeyDataKeyDataKey
Реализации

Примеры

В следующем примере кода показано, как определить значение первичного ключа записи в DetailsView элементе управления Value с помощью свойства DataKey объекта.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>

Комментарии

DataKey Класс используется для представления первичного ключа записи в элементе управления с привязкой к данным.The DataKey class is used to represent the primary key for a record in a data-bound control. Первичный ключ записи может состоять из одного или нескольких полей из источника данных.The primary key for a record can be composed of one of more fields from the data source. Несмотря на DataKey то, что класс не является коллекцией, он может хранить несколько значений ключевых полей.Although the DataKey class is not a collection, it can store multiple key field values. Значения ключевых полей заполняются при вызове одного из конструкторов для DataKey класса.The key field values are populated when one of the constructors for the DataKey class is called. Получить значение ключевого поля можно из DataKey объекта следующими способами.You can retrieve a key field value from a DataKey object in the following ways:

  • Используйте свойство для получения значения ключевого поля по указанному индексу DataKey в объекте. DataKey.Item[Int32]Use the DataKey.Item[Int32] property to retrieve a key field value at a specific index in the DataKey object.

  • DataKey.Item[String] Используйте свойство, чтобы получить значение ключевого поля для определенного поля.Use the DataKey.Item[String] property to retrieve a key field value of a specific field.

  • Используйте свойство, чтобы получить значение ключевого поля с индексом 0 DataKey в объекте. ValueUse the Value property to retrieve the value of the key field at index 0 in the DataKey object. Это свойство часто используется в качестве ярлыка для получения значения ключа записи, если первичный ключ содержит только одно поле.This property is often used as a shortcut to retrieve the key value of a record when the primary key contains only one field.

  • Используйте свойство, чтобы создать объект, который можно использовать для прохода по значениям ключевого поля. IOrderedDictionary ValuesUse the Values property to create an IOrderedDictionary object that can be used to iterate through the key field values.

Как правило, DataKey объекты автоматически создаются элементами управления с привязкой к данным, если DataKeyNames свойство элемента управления задано.In general, DataKey objects are automatically generated by data-bound controls when the control's DataKeyNames property is set. Объекты содержат значения ключевого поля или поля, DataKeyNames указанные в свойстве. DataKeyThe DataKey objects contain the values of the key field or fields specified in the DataKeyNames property. Элементы управления с привязкой к данным, которые отображают одну запись за раз ( DetailsView например FormView, или), DataKey обычно хранят DataKey объект для текущей записи, отображаемой в свойстве элемента управления.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. Элементы управления с привязкой к данным, отображающие несколько записей за раз ( GridViewнапример,), DataKey обычно хранят объекты для каждой записи DataKeyArray в элементе управления в коллекции.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. Затем Коллекция сохраняется DataKeys в свойстве элемента управления. DataKeyArrayThe DataKeyArray collection is then stored in the DataKeys property of the control.

Конструкторы

DataKey(IOrderedDictionary) DataKey(IOrderedDictionary) DataKey(IOrderedDictionary) DataKey(IOrderedDictionary)

Инициализирует новый экземпляр класса DataKey, используя указанные значения словаря ключевого поля.Initializes a new instance of the DataKey class using the specified dictionary of key field values.

DataKey(IOrderedDictionary, String[]) DataKey(IOrderedDictionary, String[]) DataKey(IOrderedDictionary, String[]) DataKey(IOrderedDictionary, String[])

Инициализирует новый экземпляр класса DataKey, используя указанные значения словаря ключевого поля и массива имен полей.Initializes a new instance of the DataKey class using the specified dictionary of key field values and array of field names.

Свойства

IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

Получает значение, указывающее, отслеживает ли объект DataKey изменения в данных о своем состоянии представления.Gets a value indicating whether the DataKey object is tracking its view-state changes.

Item[Int32] Item[Int32] Item[Int32] Item[Int32]

Возвращает значение ключевого поля с указанным индексом из объекта DataKey.Gets the value of the key field at the specified index from a DataKey object.

Item[String] Item[String] Item[String] Item[String]

Возвращает значение ключевого поля с указанным именем поля из объекта DataKey.Gets the value of the key field with the specified field name from a DataKey object.

Value Value Value Value

Получает значение ключевого поля с индексом 0 в объекте DataKey.Gets the value of the key field at index 0 in the DataKey object.

Values Values Values Values

Получает объект IOrderedDictionary, содержащий значение каждого ключевого в объекте DataKey.Gets an IOrderedDictionary object that contains every key field in the DataKey object.

Методы

Equals(DataKey) Equals(DataKey) Equals(DataKey) Equals(DataKey)

Определяет, равен ли заданный массив объектов DataKey текущему ключу данных.Determines whether the specified DataKey array is equal to the current data key.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
LoadViewState(Object) LoadViewState(Object) LoadViewState(Object) LoadViewState(Object)

Загружает сохраненное ранее состояние представления объекта DataKey.Loads the previously saved view state of the DataKey object.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
SaveViewState() SaveViewState() SaveViewState() SaveViewState()

Сохраняет текущее состояние просмотра объекта DataKey.Saves the current view state of the DataKey object.

ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)
TrackViewState() TrackViewState() TrackViewState() TrackViewState()

Отмечает точку отсчета, с которой начинает отслеживание и сохранение изменений в состоянии представления объекта DataKey.Marks the starting point at which to begin tracking and saving view-state changes to the DataKey object.

Явные реализации интерфейса

IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState

Получает значение, указывающее, отслеживает ли объект DataKey изменения в данных о своем состоянии представления.Gets a value indicating whether the DataKey object is tracking its view-state changes.

IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object)

Загружает сохраненное ранее состояние представления объекта DataKey.Loads the previously saved view state of the DataKey object.

IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState()

Сохраняет текущее состояние просмотра объекта DataKey.Saves the current view state of the DataKey object.

IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState()

Отмечает точку отсчета, с которой начинает отслеживание и сохранение изменений в состоянии представления объекта DataKey.Marks the starting point at which to begin tracking and saving view-state changes to the DataKey object.

Применяется к

Дополнительно