DetailsView.PageIndexChanging Event

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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)

member PageIndexChanging : IEvent<DetailsViewPageEventHandler,
    DetailsViewPageEventArgs>

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.

System_CAPS_noteNote

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 NIB: Consuming Events.

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

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: