DataList.OnCancelCommand Method (DataListCommandEventArgs)


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:DataListCommandEventArgs -> unit
override OnCancelCommand : 
        e:DataListCommandEventArgs -> 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 DataList 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 DataList control.


This control can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. You can use validation controls to verify user input before displaying the input text in a control. ASP.NET provides an input request validation feature to block script and HTML in user input. For more information, see Securing Standard ControlsHow to: Protect Against Script Exploits in a Web Application by Applying HTML Encoding to Strings, and Validating User Input in ASP.NET Web Pages.

Raising an event invokes the event handler through a delegate. For more information, see How to: Consume Events in a Web Forms Application.

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

The following code example demonstrates how to specify and code a handler for the CancelCommand event. It cancels any edits made to an item in the DataList control when the Cancel button is clicked.


The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see ASP.NET Web Forms Page Code Model.

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