GridView.OnRowCancelingEdit(GridViewCancelEditEventArgs) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Raises the RowCancelingEdit event.

protected:
 virtual void OnRowCancelingEdit(System::Web::UI::WebControls::GridViewCancelEditEventArgs ^ e);

protected virtual void OnRowCancelingEdit(System.Web.UI.WebControls.GridViewCancelEditEventArgs e);

abstract member OnRowCancelingEdit : System.Web.UI.WebControls.GridViewCancelEditEventArgs -> unit
override this.OnRowCancelingEdit : System.Web.UI.WebControls.GridViewCancelEditEventArgs -> unit

Protected Overridable Sub OnRowCancelingEdit (e As GridViewCancelEditEventArgs)

Parameters

e: GridViewCancelEditEventArgs

A GridViewCancelEditEventArgs that contains event data.

Exceptions

HttpException

There is no handler for the RowCancelingEdit event.

Remarks

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 Handling and Raising Events.

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(GridViewCancelEditEventArgs) in a derived class, be sure to call the base class's OnRowCancelingEdit(GridViewCancelEditEventArgs) method so that registered delegates receive the event.

Applies to

Product	Versions
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via