System.Web.UI.WebControls.GridViewPageEventArgs Class

Provides data for the GridView.PageIndexChanging event.

See Also: GridViewPageEventArgs Members

Syntax

public class GridViewPageEventArgs : System.ComponentModel.CancelEventArgs

Remarks

The System.Web.UI.WebControls.GridView control raises the GridView.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.GridView control handles the paging operation. This allows you to provide an event-handling method that performs a custom routine, such as canceling the paging operation, whenever this event occurs.

Note:

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

A System.Web.UI.WebControls.GridViewPageEventArgs object is passed to the event-handling method, 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 cancel the paging operation, set the System.ComponentModel.CancelEventArgs.Cancel property of the System.Web.UI.WebControls.GridViewPageEventArgs object to true.

For more information about handling events, see Consuming Events.

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

Requirements

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