DetailsViewPageEventArgs Class
Provides data for the PageIndexChanging event.
System::EventArgs
System.ComponentModel::CancelEventArgs
System.Web.UI.WebControls::DetailsViewPageEventArgs
Assembly: System.Web (in System.Web.dll)
The DetailsViewPageEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | DetailsViewPageEventArgs | Initializes a new instance of the DetailsViewPageEventArgs class. |
| 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 DetailsView control. |
| 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 a hash function for a particular type. (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 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.
Note |
|---|
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 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 Cancel property of the 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 DetailsViewPageEventArgs class, see the DetailsViewPageEventArgs constructor.
The following code example demonstrates how to use the DetailsViewPageEventArgs object passed to the event handler for the PageIndexChanging event to cancel a paging operation when the user attempts to navigate to another page while the DetailsView control is in edit mode.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.



Note