ListView.OnItemCanceling Method (ListViewCancelEventArgs)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Raises the ItemCanceling event.

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

protected virtual void OnItemCanceling(
	ListViewCancelEventArgs e


Type: System.Web.UI.WebControls.ListViewCancelEventArgs

The event data.

Exception Condition

There is no handler for the ItemCanceling event.

The ListView control raises the ItemCanceling event when a Cancel button in the control is clicked, but before exiting insert or edit mode. (A Cancel button is a button control whose CommandName property is set to "Cancel".) This enables you to perform a custom routine whenever this event occurs, such as stopping the cancel operation if it would put the item in an unwanted state.

The OnItemCanceling method is called by the ListView control to raise the ItemCanceling event. It is typically used by control developers when extending the ListView class.

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

The OnItemCanceling method also enables 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 you override OnItemCanceling in a derived class, call the base class's OnItemCanceling method so that registered delegates receive the event.

.NET Framework
Available since 3.5
Return to top