This documentation is archived and is not being maintained.

BaseDataList::DataKeys Property

Gets a DataKeyCollection object that stores the key values of each record in a data listing control.

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

[BrowsableAttribute(false)]
public:
property DataKeyCollection^ DataKeys {
	DataKeyCollection^ get ();
}

Property Value

Type: System.Web.UI.WebControls::DataKeyCollection
A DataKeyCollection that stores the key values of each record in a data listing control.

Use the DataKeys collection to access the key values of each record (displayed as a row) in a data listing control. 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 DataKeyField property.

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.

For more information on accessing data with ASP.NET, see ASP.NET Data Access.

The following code example demonstrates how to use the DataKeys property to determine the value of the key field for the record being deleted.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.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.
Show: