System.Web.UI.WebControls.FormViewPageEventArgs Class

Provides data for the FormView.PageIndexChanging event.

See Also: FormViewPageEventArgs Members

Syntax

public class FormViewPageEventArgs : System.ComponentModel.CancelEventArgs

Remarks

The System.Web.UI.WebControls.FormView control raises the FormView.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.FormView control handles the paging operation. You can also set the CommandArgument property of a pager button to specify the type of paging operation to perform. The following table lists the supported operations.

"Next"

Navigates to the next page.

"Prev"

Navigates to the previous page.

"First"

Navigates to the first page.

"Last"

Navigates to the last page.

An integer value

Navigates to the specified page.

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.FormView control.

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