GridView.PageIndexChanged Event (System.Web.UI.WebControls)

Welcome Sign in

Developer Centers

MSDN Home

Microsoft Developer Network

.NET Framework Class Library

GridView..::.PageIndexChanged Event

Updated: November 2007

Occurs when one of the pager buttons is clicked, but after the GridView control handles the paging operation.

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

Syntax

Visual Basic (Declaration)

Public Event PageIndexChanged As EventHandler

Visual Basic (Usage)

Dim instance As GridView
Dim handler As EventHandler

AddHandler instance.PageIndexChanged, handler

public event EventHandler PageIndexChanged

Visual C++

public:
 event EventHandler^ PageIndexChanged {
    void add (EventHandler^ value);
    void remove (EventHandler^ value);
}

/** @event */
public void add_PageIndexChanged (EventHandler value)
/** @event */
public void remove_PageIndexChanged (EventHandler value)

JScript

JScript does not support events.

ASP.NET

<asp:GridView OnPageIndexChanged="EventHandler" />

Remarks

The PageIndexChanged event is raised when one of the pager buttons is clicked, but after the GridView control handles the paging operation. This enables you to provide an event-handling method that performs a custom routine, such as a custom paging operation, whenever this event occurs.

To determine the index of the page selected by the user, use the PageIndex property of the GridView control.

For more information about handling events, see Consuming Events.

Examples

The following example demonstrates how to use the PageIndexChanged event to display the page number selected by the user from the pager row.

Visual Basic

<%@ Page language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Sub CustomersGridView_DataBound(ByVal sender As Object, ByVal e As EventArgs)

    If Not IsPostBack Then

      ' Call a helper method to display the current page number 
      ' when the page is first loaded.
      DisplayCurrentPage()

    End If

  End Sub

  Sub CustomersGridView_PageIndexChanged(ByVal sender As Object, ByVal e As EventArgs)

    ' Call a helper method to display the current page number 
    ' when the user navigates to a different page.
    DisplayCurrentPage()

  End Sub

  Sub DisplayCurrentPage()

    ' Calculate the current page number.
    Dim currentPage As Integer = CustomersGridView.PageIndex + 1

    ' Display the current page number. 
    Message.Text = "Page " & currentPage.ToString() & " of " & _
      CustomersGridView.PageCount.ToString() & "."

  End Sub

</script>

<html  >
  <head runat="server">
    <title>GridView PageIndexChanged Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>GridView PageIndexChanged Example</h3>

      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>

      <br/>  

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true"
        ondatabound="CustomersGridView_DataBound"
        onpageindexchanged="CustomersGridView_PageIndexChanged"
        runat="server">

        <pagersettings mode="Numeric"
          position="Bottom"           
          pagebuttoncount="10"/>

        <pagerstyle backcolor="LightBlue"/>

      </asp:gridview>

      <!-- 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#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  void CustomersGridView_DataBound(Object sender, EventArgs e)
  {
    if (!IsPostBack)
    {
      // Call a helper method to display the current page number 
      // when the page is first loaded.
      DisplayCurrentPage();
    }
  }

  void CustomersGridView_PageIndexChanged(Object sender, EventArgs e)
  {
    // Call a helper method to display the current page number 
    // when the user navigates to a different page.
    DisplayCurrentPage();
  }

  void DisplayCurrentPage()
  {
    // Calculate the current page number.
    int currentPage = CustomersGridView.PageIndex + 1;

    // Display the current page number. 
    Message.Text = "Page " + currentPage.ToString() + " of " + 
      CustomersGridView.PageCount.ToString() + ".";
  }

</script>

<html  >
  <head runat="server">
    <title>GridView PageIndexChanged Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>GridView PageIndexChanged Example</h3>

      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>

      <br/>  

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true"
        ondatabound="CustomersGridView_DataBound"
        onpageindexchanged="CustomersGridView_PageIndexChanged"
        runat="server">

        <pagersettings mode="Numeric"
          position="Bottom"           
          pagebuttoncount="10"/>

        <pagerstyle backcolor="LightBlue"/>

      </asp:gridview>

      <!-- 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 Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information