System.Web.UI.WebControls.GridViewCancelEditEventArgs Class

Provides data for the GridView.RowCancelingEdit event.

See Also: GridViewCancelEditEventArgs Members


public class GridViewCancelEditEventArgs : System.ComponentModel.CancelEventArgs


The System.Web.UI.WebControls.GridView control raises the GridView.RowCancelingEdit event when the Cancel button (a button with its CommandName property set to "Cancel") is clicked, but before exiting edit mode. This allows you to provide an event-handling method that performs a custom routine, such as stopping the cancel operation if it would put the row in an undesired state, whenever this event occurs.

A System.Web.UI.WebControls.GridViewCancelEditEventArgs object is passed to the event-handling method, which allows you to determine the index of the row containing the Cancel button that raised the event and to indicate that the cancel operation should be stopped. To stop the cancel operation, set the System.ComponentModel.CancelEventArgs.Cancel property 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.GridViewCancelEditEventArgs, see the GridViewCancelEditEventArgs.#ctor(int) constructor.


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