In this article I will explain with an example, how to use the DataKeyNames (DataKeys) property of GridView in ASP.Net using C# and VB.Net.
 
 

What are DataKeyNames and DataKeys?

DataKeyNames is the property of GridView which allows us to set the names of the Column Fields, that we want to use in code but do not want to display it. Example Primary Keys, ID fields, etc.
The values Column Fields which are set in DataKeyNames are available in code in DataKeys object which saves it in an Array called as DataKeyArray.
 
 

HTML Markup

The following HTML Markup consists of:
GridView - For displaying the records.
 

Columns

The GridView consists of two BoundField columns and one TemplateField column consisting of a Button control.
 

Properties

The GridView has been assigned with a DataKeyNames property.
The Button has been assigned with an OnClick event handler.
<asp:GridView ID="gvCustomers" runat="server" AutoGenerateColumns="false" DataKeyNames="Id">
    <Columns>
        <asp:BoundField DataField="Name" HeaderText="Name" />
        <asp:BoundField DataField="Country" HeaderText="Country" />
        <asp:TemplateField>
            <ItemTemplate>
                <asp:Button ID="btnGet" Text="Get Value" runat="server" OnClick="OnGet" />
            </ItemTemplate>
        </asp:TemplateField>
    </Columns>
</asp:GridView>
 
 

Namespaces

You will need to import the following namespace.
C#
using System.Data;
 
VB.Net
Imports System.Data
 
 

Binding the GridView

Inside the Page_Load event handler, an object of DataTable is created.
Then, three columns are added to the DataTable Columns collection using the AddRange method.
An Array of objects of type DataColumn is specified which will hold the name and the optional parameter Data Type i.e. the Type of the column.
Once the schema is ready i.e. all the columns are defined, some rows have been added using the Rows.Add method.
Finally, the DataTable is assigned to the DataSource property of the GridView and the GridView is populated.
Note: For more details on how to use Dynamic DataTable, please refer my article Dynamically create DataTable and bind to GridView in ASP.Net.
 
C#
protected void Page_Load(object sender, EventArgs e)
{
    if (!this.IsPostBack)
    {
        DataTable dt = new DataTable();
        dt.Columns.AddRange(new DataColumn[3] {
                            new DataColumn("Id"),
                            new DataColumn("Name"),
                            new DataColumn("Country") });
        dt.Rows.Add(1, "John Hammond", "United States");
        dt.Rows.Add(2, "Mudassar Khan", "India");
        dt.Rows.Add(3, "Suzanne Mathews", "France");
        dt.Rows.Add(4, "Robert Schidner", "Russia");
        gvCustomers.DataSource = dt;
        gvCustomers.DataBind();
    }
}
 
VB.Net
Protected Sub Page_Load(sender As Object, e As EventArgs) Handles Me.Load
    If Not Me.IsPostBack Then
        Dim dt As New DataTable()
        dt.Columns.AddRange(New DataColumn(2) {
                            New DataColumn("Id"),
                            New DataColumn("Name"),
                            New DataColumn("Country")})
        dt.Rows.Add(1, "John Hammond", "United States")
        dt.Rows.Add(2, "Mudassar Khan", "India")
        dt.Rows.Add(3, "Suzanne Mathews", "France")
        dt.Rows.Add(4, "Robert Schidner", "Russia")
        gvCustomers.DataSource = dt
        gvCustomers.DataBind()
    End If
End Sub
 
 

Getting the DataKeys value for a particular GridView Row

When Get Value Button is clicked, first the GridView Row is determined using the NamingContainer property.
Then, using the Row Index, the DataKeys array is accessed and the value of the Column is fetched.
Finally, the DataKey is displayed using JavaScript Alert Message Box using RegisterStartupScript method.
C#
protected void OnGet(object sender, EventArgs e)
{
    //Determine the RowIndex of the Row whose Button was clicked.
    int rowIndex = ((sender as Button).NamingContainer as GridViewRow).RowIndex;
 
    //Get the value of column from the DataKeys using the RowIndex.
    int id = Convert.ToInt32(gvCustomers.DataKeys[rowIndex].Values[0]);
    ClientScript.RegisterStartupScript(this.GetType(), "alert", "alert('DataKey: " + id + "');", true);
}
 
VB.Net
Protected Sub OnGet(sender As Object, e As EventArgs)
    'Determine the RowIndex of the Row whose Button was clicked.
    Dim rowIndex As Integer = TryCast(TryCast(sender, Button).NamingContainer, GridViewRow).RowIndex
 
    'Get the value of column from the DataKeys using the RowIndex.
    Dim id As Integer = Convert.ToInt32(gvCustomers.DataKeys(rowIndex).Values(0))
    ClientScript.RegisterStartupScript(Me.GetType(), "alert", "alert('DataKey: " & id & "');", True)
End Sub
 
 

Screenshot

Understanding ASP.Net GridView DataKeyNames (DataKeys) with examples
 
 

Demo

View Demo
 
 

Downloads

Download Code