DetailsView.AutoGenerateDeleteButton Property

 

Gets or sets a value indicating whether the built-in control to delete the current record is displayed in a DetailsView control.

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

abstract AutoGenerateDeleteButton : bool with get, set
override AutoGenerateDeleteButton : bool with get, set

Property Value

Type: System.Boolean

true to display the built-in control to delete the current record; otherwise, false. The default is false.

When a DetailsView control is bound to an object that inherits from DataSourceView and the CanDelete property returns true, the DetailsView control can take advantage of the data source control's capabilities and provide automatic deleting functionality.

System_CAPS_noteNote

For a SqlDataSourceView object to delete data, the SqlDataSource.DeleteCommand property of the underlying SqlDataSource object must be set with a delete query statement.

When the AutoGenerateDeleteButton property is set to true, a CommandField row field with a Delete button is automatically displayed in the DetailsView control. Clicking the Delete button permanently removes that record from the data source.

System_CAPS_noteNote

You must also set the DataKeyNames property for the automatic deletion feature to work.

The DetailsView control provides several events that you can use to perform a custom action when a record is deleted. The following table lists the available events.

Event

Description

ItemDeleted

Occurs when the Delete button is clicked, but after the DetailsView control deletes the record from the data source. This event is often used to check the results of the delete operation.

ItemDeleting

Occurs when the Delete button is clicked, but before the DetailsView control deletes the record from the data source. This event is often used to cancel the delete operation.

The value of AutoGenerateDeleteButton is stored in view state.

The following code example demonstrates how to use the AutoGenerateDeleteButton property to display the built-in control to delete the current record.

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

.NET Framework
Available since 2.0
Return to top
Show: