System.Web 2.0.0.0 System.ComponentModel.CancelEventArgs

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

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

For more information about handling events, see Consuming Events.

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

Provides data for the event.

- Constructor
  To be added.

  Use this constructor to initialize a new instance of the class.

  The following table shows the initial property value for an instance of .

  Property

  Initial value

  The value of the parameter.

  This constructor is used primarily by control developers when raising events.

  Initializes a new instance of the class.

  2.0.0.0
- Property
  System.Int32 To be added.

  Because the event occurs before the control performs the paging operation, the property of the control contains the index of the previously displayed page and cannot be used to determine the index of the page selected by the user. Use the property to determine the page index. You can also use this property to programmatically override the page index selected by the user by setting it to another value.

  Gets or sets the index of the new page to display in the control.

  2.0.0.0