BaseDataList::DataKeyField Property

 

Gets or sets the key field in the data source specified by the DataSource property.

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

public:
[ThemeableAttribute(false)]
property String^ DataKeyField {
	virtual String^ get();
	virtual void set(String^ value);
}

Property Value

Type: System::String^

The name of the key field in the data source specified by DataSource.

Use the DataKeyField property to specify the key field in the data source indicated by the DataSource property. The specified field is used to populate the DataKeys collection. This allows you to store the key field with a data listing control without displaying it in the control. 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.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

The following code example demonstrates how to use the DataKeyField property to specify the key field for the data source.

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

.NET Framework
Available since 1.1
Return to top
Show: