GridView.AutoGenerateDeleteButton プロパティ

.NET Framework クラス ライブラリ リファレンス

GridView.AutoGenerateDeleteButton プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

データ行ごとに Delete ボタンを持つ CommandField フィールド列を自動的に GridView コントロールに追加するかどうかを示す値を取得または設定します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Overridable Property
 AutoGenerateDeleteButton As Boolean

Visual Basic (使用法)

Dim instance As GridView
Dim value As Boolean

value = instance.AutoGenerateDeleteButton

instance.AutoGenerateDeleteButton = value

C#

public virtual bool AutoGenerateDeleteButton
 { get; set; }

C++

public:
virtual property bool AutoGenerateDeleteButton {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_AutoGenerateDeleteButton ()

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

JScript

public function get AutoGenerateDeleteButton
 () : boolean

public function set AutoGenerateDeleteButton
 (value : boolean)

プロパティ値
データ行ごとに Delete ボタンを持つ CommandField フィールド列を自動的に追加する場合は true。それ以外の場合は false。既定値は false です。

解説

削除機能をサポートしているデータ ソース コントロールが GridView コントロールにバインドされている場合、GridView コントロールは、データ ソース コントロールの機能を利用して、自動削除機能を提供します。

メモ
データを削除するデータ ソース コントロールの場合、データを削除するように構成する必要があります。レコードを削除するデータ ソース コントロールの構成については、該当するデータ ソース コントロールのドキュメントを参照してください。

AutoGenerateDeleteButton プロパティが true に設定されている場合、データ行ごとに Delete ボタンを持つ (CommandField オブジェクトで表される) 列が自動的に GridView コントロールに追加されます。行の Delete ボタンをクリックすると、そのレコードが完全にデータ ソースから削除されます。

メモ
自動削除機能を使用するには、DataKeyNames プロパティを使用して、データ ソースの 1 つ以上の主キー フィールドも指定する必要があります。

GridView コントロールには、行が削除されるときにカスタム アクションを実行するために使用できる複数のイベントが用意されています。使用できるイベントの一覧を次の表に示します。

イベント	説明
RowDeleted	行の Delete ボタンがクリックされた場合に、GridView コントロールがデータ ソースからレコードを削除した後に発生します。このイベントは、削除操作の結果を確認する場合によく使用されます。
RowDeleting	行の Delete ボタンがクリックされた場合に、GridView コントロールがデータ ソースからレコードを削除する前に発生します。このイベントは、削除操作をキャンセルする場合によく使用されます。

使用例

AutoGenerateDeleteButton プロパティを使用して、GridView コントロールの自動削除機能を有効にする方法を次のコード例に示します。

Visual Basic

<%@ Page language="VB" %>

<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>

C#

<%@ 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
GridView クラス
GridView メンバ
System.Web.UI.WebControls 名前空間
CommandField クラス
AutoGenerateEditButton
AutoGenerateSelectButton
GridView.AutoGenerateColumns プロパティ
DeleteCommand