Export (0) Print
Expand All

DataKeyCollection Class

Represents a collection that contains the key field of each record in a data source. This class cannot be inherited.

System::Object
  System.Web.UI.WebControls::DataKeyCollection

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

public ref class DataKeyCollection sealed : ICollection, 
	IEnumerable

The DataKeyCollection type exposes the following members.

  NameDescription
Public methodDataKeyCollectionInitializes a new instance of the DataKeyCollection class.
Top

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

  NameDescription
Public methodCopyToCopies all the items from the DataKeyCollection to the specified System::Array object, starting at the specified index in the System::Array object.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetEnumeratorCreates a System.Collections::IEnumerator implemented object that contains all key fields in the DataKeyCollection.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (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

The DataKeyCollection class represents a collection of the key fields in the data source. The key field of each record in the data source is stored in this collection. This allows you to store the key field with a data listing control without displaying it in the control. This collection is automatically filled with the values from the field specified by the BaseDataList::DataKeyField property. This collection does not allow you to manually add or remove items from the collection.

The key field is commonly used in a handler for an event, such as ItemCommand or DeleteCommand, as part of an update query string to revise a specific record in the data source. The key field helps the update query string identify the appropriate record to modify.

Use the Count property to determine the number of items in the collection. To programmatically retrieve a key field from a DataKeyCollection, use one of following methods:

  • Use the indexer to get a single key field from the collection, using array notation.

  • Use the CopyTo method to copy the contents of the collection to a System::Array object, which can then be used to get items from the collection.

  • Use the GetEnumerator method to create a System.Collections::IEnumerator implemented object, which can then be used to get items from the collection.

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

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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:
© 2014 Microsoft