GridView::OnRowCancelingEdit Method (GridViewCancelEditEventArgs^)

.NET Framework (current version)

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

Syntax

protected:
virtual void OnRowCancelingEdit(
	GridViewCancelEditEventArgs^ e
)

Parameters

e: Type: System.Web.UI.WebControls::GridViewCancelEditEventArgs^
A GridViewCancelEditEventArgs that contains event data.

Exceptions

Exception	Condition
HttpException	There is no handler for the RowCancelingEdit event.

The RowCancelingEdit event is raised when the Cancel button of a row in edit mode is clicked, but before the row exits edit mode. This enables 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.

Raising an event invokes the event handler through a delegate. For more information, see NIB: Raising an Event.

The OnRowCancelingEdit method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors:

When overriding OnRowCancelingEdit in a derived class, be sure to call the base class's OnRowCancelingEdit method so that registered delegates receive the event.

Version Information

.NET Framework
Available since 2.0