DataKeys Property
Collapse the table of content
Expand the table of content

GridView.DataKeys Property


Gets a collection of DataKey objects that represent the data key value of each row in a GridView control.

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

public virtual DataKeyArray DataKeys { get; }

Property Value

Type: System.Web.UI.WebControls.DataKeyArray

A DataKeyArray that contains the data key of each row in a GridView control.

When the DataKeyNames property is set, the GridView control automatically creates a DataKey object for each row in the control. The DataKey object contains the values of the field or fields specified in the DataKeyNames property. The DataKey objects are then added to the control's DataKeys collection. Use the DataKeys property to retrieve the DataKey object for a specific data row in the GridView control.


You can use the SelectedDataKey property to retrieve the DataKey object for the currently selected row. You can also use the SelectedValue property to retrieve the data key value for the currently selected row directly.

The following example demonstrates how to use the DataKeys property to determine the data key value of the selected row in a GridView control.

<%@ Page language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">

  void CustomersGridView_SelectedIndexChanged(Object sender, EventArgs e)

    // Determine the index of the selected row.
    int index = CustomersGridView.SelectedIndex;

    // Display the primary key value of the selected row.
    Message.Text = "The primary key value of the selected row is " +
        CustomersGridView.DataKeys[index].Value.ToString() + ".";



<html xmlns="" >
  <head runat="server">
    <title>GridView DataKeys Example</title>
    <form id="form1" runat="server">

      <h3>GridView DataKeys Example</h3>

      <asp:label id="Message"


      <asp:gridview id="CustomersGridView" 
        emptydatatext="No data available." 


      <!-- 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="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 


.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft