This documentation is archived and is not being maintained.

DataKeyArray Class

Represents a collection of DataKey objects. This class cannot be inherited.

System::Object
  System.Web.UI.WebControls::DataKeyArray

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public ref class DataKeyArray sealed : ICollection, 
	IEnumerable, IStateManager

The DataKeyArray type exposes the following members.

  NameDescription
Public methodDataKeyArrayInitializes a new instance of the DataKeyArray class.
Top

  NameDescription
Public propertyCountGets the number of items in the collection.
Public propertyIsReadOnlyGets a value indicating whether the items in the collection can be modified.
Public propertyIsSynchronizedGets a value indicating whether the DataKeyArray collection is synchronized (thread safe).
Public propertyItemGets the DataKey object from the collection at the specified index.
Public propertySyncRootGets the object used to synchronize access to the collection.
Top

  NameDescription
Public methodCopyToCopies all the items from this collection to the specified array of DataKey objects, starting at the specified index in the array.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that contains all DataKey objects in the collection.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodCast<TResult>Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection::CopyToInfrastructure. Copies all the items from this collection to the specified System::Array, starting at the specified index in the System::Array.
Explicit interface implemetationPrivate propertyIStateManager::IsTrackingViewStateInfrastructure. Gets a value indicating whether the DataKeyArray object is tracking its view-state changes.
Explicit interface implemetationPrivate methodIStateManager::LoadViewStateInfrastructure. Loads the previously saved view state of the DataKeyArray object.
Explicit interface implemetationPrivate methodIStateManager::SaveViewStateInfrastructure. Saves the current view state of the DataKeyArray object.
Explicit interface implemetationPrivate methodIStateManager::TrackViewStateInfrastructure. Marks the starting point at which to begin tracking and saving view-state changes to the DataKeyArray object.
Top

The DataKeyArray class is used to store and manage a collection of DataKey objects. A DataKey object represents the primary key of a record in a data-bound control. In general, data-bound controls that display multiple records (such as the GridView control) use a DataKeyArray object to store the DataKey objects for the records displayed in the control.

The DataKeyArray class supports several ways to access the items in the collection:

  • Use the Item indexer to directly retrieve a DataKey object from the collection at a specific zero-based index.

  • Use the GetEnumerator method to retrieve an enumerator that can be used to iterate through the collection.

  • Use the CopyTo method to copy the items in the collection into an array, which can then be used to access the items in the collection.

To determine the total number of items in the collection, use the Count property.

The following code example demonstrates how to use the indexer to retrieve a DataKey object from a DataKeyArray collection.

No code example is currently available or this language may not be supported.

The following code example demonstrates how to iterate through a DataKeyArray collection.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: