System.Web.UI.WebControls.DetailsViewPageEventArgs Class

Provides data for the DetailsView.PageIndexChanging event.

See Also: DetailsViewPageEventArgs Members


public class DetailsViewPageEventArgs : System.ComponentModel.CancelEventArgs


The System.Web.UI.WebControls.DetailsView control raises the DetailsView.PageIndexChanging event when a pager button (a button with its CommandName property set to "Page") within the control is clicked, but before the System.Web.UI.WebControls.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.


Pager buttons are usually located in the pager row of a System.Web.UI.WebControls.DetailsView control.

A System.Web.UI.WebControls.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 whether the paging operation should be canceled. To determine the index of the page selected by the user, use the DetailsViewPageEventArgs.NewPageIndex property. To cancel the paging operation, set the System.ComponentModel.CancelEventArgs.Cancel property of the System.Web.UI.WebControls.DetailsViewPageEventArgs object to true.

For more information about handling events, see Consuming Events.

For a list of initial property values for an instance of the System.Web.UI.WebControls.DetailsViewPageEventArgs class, see the DetailsViewPageEventArgs.#ctor(int) constructor.


Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
Assembly Versions:
Since: .NET 2.0