System.Web.UI.WebControls.DetailsViewDeleteEventArgs Class

Provides data for the DetailsView.ItemDeleting event.

See Also: DetailsViewDeleteEventArgs Members


public class DetailsViewDeleteEventArgs : System.ComponentModel.CancelEventArgs


The System.Web.UI.WebControls.DetailsView control raises the DetailsView.ItemDeleting event when a Delete button (a button with its CommandName property set to "Delete") within the control is clicked, but before the System.Web.UI.WebControls.DetailsView control deletes the record. This allows you to provide an event handler that performs a custom routine, such as verifying a record before deleting it, whenever this event occurs.

A System.Web.UI.WebControls.DetailsViewDeletedEventArgs object is passed to the event handler, which allows you to determine the index of the record being deleted and to indicate that the delete operation should be canceled. To determine the index of a record, use the DetailsViewDeleteEventArgs.RowIndex property. To cancel the delete operation, set the System.ComponentModel.CancelEventArgs.Cancel property to true. You can also access the key fields and non-key fields by using the DetailsViewDeleteEventArgs.Keys and DetailsViewDeleteEventArgs.Values properties, respectively. These values are useful if you want to verify the record before deleting it.


It is possible to modify the key field values in the DetailsViewDeleteEventArgs.Keys property. If you change these values, the record that corresponds to the new key field values will be deleted.

For more information about handling events, see Consuming Events.

For a list of initial property values for an instance of System.Web.UI.WebControls.DetailsViewDeleteEventArgs class, see the DetailsViewDeleteEventArgs.#ctor(int) constructor.


Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
Assembly Versions:
Since: .NET 2.0