GridViewCancelEditEventArgs Class
Collapse the table of content
Expand the table of content

GridViewCancelEditEventArgs Class

Provides data for the RowCancelingEdit event.


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

type GridViewCancelEditEventArgs =  
        inherit CancelEventArgs 

The GridViewCancelEditEventArgs type exposes the following members.

Public methodGridViewCancelEditEventArgsInitializes a new instance of the GridViewCancelEditEventArgs class.

Public propertyCancelGets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public propertyRowIndexGets the index of the row containing the Cancel button that raised the event.

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The GridView control raises the 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 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 Cancel property to true.

For more information about handling events, see Consuming Events.

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

The following example demonstrates how to use the GridViewCancelEditEventArgs object passed to the event-handling method to determine the index of the row containing the Cancel button clicked by the user.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft