Export (0) Print
Expand All

GridView.AutoGenerateDeleteButton Property

Note: This property is new in the .NET Framework version 2.0.

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)

public virtual bool AutoGenerateDeleteButton { get; set; }
/** @property */
public boolean get_AutoGenerateDeleteButton ()

/** @property */
public void set_AutoGenerateDeleteButton (boolean value)

public function get AutoGenerateDeleteButton () : boolean

public function set AutoGenerateDeleteButton (value : boolean)

Property Value

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 code example demonstrates how to use the AutoGenerateDeleteButton property to enable the automatic deleting feature of a GridView control.


<%@ Page language="C#" %>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView Edit Example</h3>

      <!-- The GridView control automatically sets the columns     -->
      <!-- specified in the datakeynames property as read-only.    -->
      <!-- No input controls are rendered for these columns in     -->
      <!-- edit mode.                                              -->
      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="true"
        autogeneratedeletebutton="true"
        autogenerateeditbutton="true"
        datakeynames="CustomerID"  
        runat="server">
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSqlDataSource"  
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        updatecommand="Update Customers SET CompanyName=@CompanyName, Address=@Address, City=@City, PostalCode=@PostalCode, Country=@Country WHERE (CustomerID = @CustomerID)"
        deletecommand="Delete from Customers where CustomerID = @CustomerID"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>


Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft