Export (0) Print
Expand All

DataGrid::OnCancelCommand Method

Raises the CancelCommand event. This allows you to provide a custom handler for the event.

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

protected:
virtual void OnCancelCommand(
	DataGridCommandEventArgs^ e
)

Use the OnCancelCommand method to provide a custom handler for the CancelCommand event.

The CancelCommand event is raised when the Cancel button is clicked for an item in the DataGrid control.

A typical handler for the CancelCommand event sets the EditItemIndex property to -1 (to deselect the item) and then rebinds the data to the DataGrid control.

Caution noteCaution

Text is not HTML encoded before it is displayed in the DataGrid control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.

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

Notes to Inheritors

When overriding OnCancelCommand in a derived class, be sure to call the base class's OnCancelCommand method.

For more information about handling events, see Consuming Events.

The following code example demonstrates how to specify and code a handler for the CancelCommand event to cancel edits made to an item in the DataGrid control.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft