The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

FormViewPageEventArgs Class

.NET Framework (current version)

Other Versions

Provides data for the PageIndexChanging event.

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

Inheritance Hierarchy

System::Object
System::EventArgs
System.ComponentModel::CancelEventArgs
System.Web.UI.WebControls::FormViewPageEventArgs

Syntax

C++

public ref class FormViewPageEventArgs : CancelEventArgs

Constructors

	Name	Description
	FormViewPageEventArgs(Int32)	Initializes a new instance of the FormViewPageEventArgs class.

Properties

	Name	Description
	Cancel	Gets or sets a value indicating whether the event should be canceled.(Inherited from CancelEventArgs.)
	NewPageIndex	Gets or sets the index of the new page to display in the FormView control.

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

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

CommandArgument value	Description
"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 FormView control.

A 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 NewPageIndex property. To cancel the paging operation, set the CancelEventArgs::Cancel property of the FormViewPageEventArgs object to true.

For more information about handling events, see NIB: Consuming Events.

For a list of initial property values for an instance of the FormViewPageEventArgs class, see the FormViewPageEventArgs constructor.

Examples

The following example demonstrates how to use the FormViewPageEventArgs object passed to the event-handling method for the PageIndexChanging event to cancel a paging operation when the user attempts to navigate to another page while the FormView control is in edit mode.

Security Note
The control in this example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.