DetailsView.PageIndexChanging Event

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

Occurs when the value of the PageIndex property changes before a paging operation.

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

public event DetailsViewPageEventHandler PageIndexChanging
/** @event */
public void add_PageIndexChanging (DetailsViewPageEventHandler value)

/** @event */
public void remove_PageIndexChanging (DetailsViewPageEventHandler value)

JScript supports the use of events, but not the declaration of new ones.

The DetailsView control raises the PageIndexChanging event when a pager button (a button with its CommandName property set to "Page") within the control is clicked, but before the DetailsView control handles the paging operation. This allows you to provide an event handler that performs a custom routine, such as canceling the paging operation, whenever this event occurs.


This event is not raised when you programmatically set the PageIndex property.

Pager buttons are usually located in the pager row of a DetailsView control.

A DetailsViewPageEventArgs object is passed to the event handler, which allows you to determine the index of the page selected by the user and to indicate that the paging operation should be canceled. To determine the index of the page selected by the user, use the NewPageIndex property. To cancel the paging operation, set the Cancel property of the DetailsViewPageEventArgs object to true.

For more information about handling events, see Consuming Events.

The following code example demonstrates how to use the PageIndexChanging event to cancel a paging operation.

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

<script runat="server">

    void CustomerDetailView_ItemCommand(Object sender, 
      DetailsViewCommandEventArgs e)
        // Clear the error message if the user cancels the edit 
        // operation.
        if (e.CommandName == "Cancel")
            ErrorMessageLabel.Text = "";

    protected void CustomerDetailView_PageIndexChanging(
      object sender, DetailsViewPageEventArgs e)
        // Cancel the paging operation if the user tries to 
        // navigate to another record while in edit mode.
        if (CustomerDetailView.CurrentMode == DetailsViewMode.Edit)
            e.Cancel = true;
            // Display an error message.
            ErrorMessageLabel.Text = 
              "You cannot navigate to another record while in edit mode.";


    <form id="Form1" runat="server">
            DetailsView CurrentMode Example</h3>
        <asp:DetailsView ID="CustomerDetailView" 
          <HeaderStyle BackColor="Navy" ForeColor="White" />
        <br />
        <asp:Label ID="ErrorMessageLabel" 
          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="DetailsViewSource" runat="server" 
            "<%$ ConnectionStrings:NorthWindConnectionString%>"
          InsertCommand="INSERT INTO [Customers]([CustomerID],
            [CompanyName], [Address], [City], [PostalCode], [Country]) 
            VALUES (@CustomerID, @CompanyName, @Address, @City, 
            @PostalCode, @Country)"
          SelectCommand="Select [CustomerID], [CompanyName], 
            [Address], [City], [PostalCode], [Country] From 

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.

.NET Framework

Supported in: 2.0

Community Additions