GridView.SelectedIndex Property (System.Web.UI.WebControls)

Switch View

SelectedIndex Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

.NET Framework Class Library

GridView.SelectedIndex Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the index of the selected row in a GridView control.

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

Syntax

Visual Basic (Declaration)

<BindableAttribute(True)> _
Public Overridable Property SelectedIndex As Integer

Visual Basic (Usage)

Dim instance As GridView
Dim value As Integer

value = instance.SelectedIndex

instance.SelectedIndex = value

[BindableAttribute(true)] 
public virtual int SelectedIndex { get; set; }

C++

[BindableAttribute(true)] 
public:
virtual property int SelectedIndex {
    int get ();
    void set (int value);
}

/** @property */
public int get_SelectedIndex ()

/** @property */
public void set_SelectedIndex (int value)

JScript

public function get SelectedIndex () : int

public function set SelectedIndex (value : int)

Property Value

The zero-based index of the selected row in a GridView control. The default is -1, which indicates that no row is currently selected.

Exceptions

Exception type	Condition
ArgumentOutOfRangeException	The SelectedIndex property is set to a value less than -1.

Remarks

Use the SelectedIndex property to determine the index of the currently selected row in a GridView control. You can also use this property to programmatically select a row in the control. To clear the selection of a row, set this property to -1. The appearance of the currently selected row can be customized by using the SelectedRowStyle property. To access the currently selected row, use the SelectedRow property.

Example

The following code example demonstrates how to use the SelectedIndex property to select the second row in a GridView control when the control is initially displayed.

Visual Basic

<%@ Page language="VB" %>

<script runat="server">

  Sub CustomersGridView_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs)
        
    ' Get the currently selected row using the SelectedRow property.
    Dim row As GridViewRow = CustomersGridView.SelectedRow
        
    ' Display the company name from the selected row.
    ' In this example, the third column (index 2) contains
    ' the company name.
    Message.Text = "You selected " & row.Cells(2).Text & "."
    
  End Sub

  Sub CustomersGridView_SelectedIndexChanging(ByVal sender As Object, ByVal e As GridViewSelectEventArgs)
        
    ' Get the currently selected row. Because the SelectedIndexChanging event
    ' occurs before the select operation in the GridView control, the
    ' SelectedRow property cannot be used. Instead, use the Rows collection
    ' and the NewSelectedIndex property of the e argument passed to this 
    ' event handler.
    Dim row As GridViewRow = CustomersGridView.Rows(e.NewSelectedIndex)

    ' You can cancel the select operation by using the Cancel
    ' property. For this example, if the user selects a customer with 
    ' the ID "ANATR", the select operation is canceled and an error message
    ' is displayed.
    If row.Cells(1).Text = "ANATR" Then
 
      e.Cancel = True
      Message.Text = "You cannot select " + row.Cells(2).Text & "."
      
    End If
    
  End Sub

</script>

<html>
  <body>
    <form runat="server">
        
     <h3>GridView Select Example</h3>

     <asp:gridview id="CustomersGridView" 
       datasourceid="CustomersSource" 
       autogeneratecolumns="true"
       autogenerateselectbutton="true"
       allowpaging="true" 
       selectedindex="0"
       onselectedindexchanged="CustomersGridView_SelectedIndexChanged"
       onselectedindexchanging="CustomersGridView_SelectedIndexChanging"   
       runat="server">
                
       <selectedrowstyle backcolor="LightCyan"
         forecolor="DarkBlue"
         font-bold="true"/>  
                
     </asp:gridview>
            
      <br/>
            
      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>
            
      <!-- 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%>" 
        runat="server"/>
            
    </form>
  </body>
</html>

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

<script runat="server">

  void CustomersGridView_SelectedIndexChanged(Object sender, EventArgs e)
  {
    
    // Get the currently selected row using the SelectedRow property.
    GridViewRow row = CustomersGridView.SelectedRow;
        
    // Display the company name from the selected row.
    // In this example, the third column (index 2) contains
    // the company name.
    Message.Text = "You selected " + row.Cells[2].Text + ".";
    
  }

  void CustomersGridView_SelectedIndexChanging(Object sender, GridViewSelectEventArgs e)
  {
        
    // Get the currently selected row. Because the SelectedIndexChanging event
    // occurs before the select operation in the GridView control, the
    // SelectedRow property cannot be used. Instead, use the Rows collection
    // and the NewSelectedIndex property of the e argument passed to this 
    // event handler.
    GridViewRow row = CustomersGridView.Rows[e.NewSelectedIndex];

    // You can cancel the select operation by using the Cancel
    // property. For this example, if the user selects a customer with 
    // the ID "ANATR", the select operation is canceled and an error message
    // is displayed.
    if (row.Cells[1].Text == "ANATR")
    {
        
      e.Cancel = true;
      Message.Text = "You cannot select " + row.Cells[2].Text + ".";
        
    }
    
  }

</script>

<html>
  <body>
    <form runat="server">
        
     <h3>GridView Select Example</h3>

     <asp:gridview id="CustomersGridView" 
       datasourceid="CustomersSource" 
       autogeneratecolumns="true"
       autogenerateselectbutton="true"
       allowpaging="true" 
       selectedindex="0"
       onselectedindexchanged="CustomersGridView_SelectedIndexChanged"
       onselectedindexchanging="CustomersGridView_SelectedIndexChanging"   
       runat="server">
                
       <selectedrowstyle backcolor="LightCyan"
         forecolor="DarkBlue"
         font-bold="true"/>  
                
     </asp:gridview>
            
      <br/>
            
      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>
            
      <!-- 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%>" 
        runat="server"/>
            
    </form>
  </body>
</html>

Platforms

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0

Reference

GridView Class
GridView Members
System.Web.UI.WebControls Namespace
GridView.SelectedDataKey Property
SelectedRow
SelectedValue
SelectedRowStyle