Export (0) Print
Expand All
Expand Minimize

GridView.AutoGenerateDeleteButton Property

Gets or sets a value indicating whether a CommandField field column with a Delete button for each data row is automatically added to a GridView 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
<asp:GridView AutoGenerateDeleteButton="True|False" />

Property Value

Type: System.Boolean
true to automatically add a CommandField field column with a Delete button for each data row; otherwise, false. The default is false.

When a data source control that supports deleting is bound to a GridView control, the GridView control can take advantage of the data source control's capabilities and provide automatic deleting functionality.

NoteNote

For a data source control to delete data, it must be configured to delete data. To configure a data source control to delete records, see the documentation for the specific data source control.

When the AutoGenerateDeleteButton property is set to true, a column (represented by a CommandField object) with a Delete button for each data row is automatically added to the GridView control. Clicking the Delete button for a row permanently removes that record from the data source.

NoteNote

You must also set the DataKeyNames property to identify the key field or fields of the data source for the automatic deleting feature to work.

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

Event

Description

RowDeleted

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

RowDeleting

Occurs when a row's Delete button is clicked, but before the GridView control deletes the record from the data source. This event is often used to cancel the deleting operation.

The following example demonstrates how to use the AutoGenerateDeleteButton property to enable the automatic deleting feature of a GridView control.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft