OnCancelCommand Method

DataGrid.OnCancelCommand Method (DataGridCommandEventArgs)

 

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)

abstract OnCancelCommand : 
        e:DataGridCommandEventArgs -> unit
override OnCancelCommand : 
        e:DataGridCommandEventArgs -> unit

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.

System_CAPS_cautionCaution

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 NIB: 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 NIB: 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
Available since 1.1
Return to top
Show:
© 2016 Microsoft