DetailsView.AutoGenerateDeleteButton プロパティ

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

DetailsView.AutoGenerateDeleteButton プロパティ

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

現在のレコードを削除するための組み込みのコントロールを DetailsView コントロールに表示するかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Overridable Property
 AutoGenerateDeleteButton As Boolean

Visual Basic (使用法)

Dim instance As DetailsView
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)

プロパティ値
現在のレコードを削除するための組み込みのコントロールを表示する場合は true。それ以外の場合は false。既定値は false です。

解説

DetailsView コントロールがDataSourceView から継承されるオブジェクトにバインドされている場合、CanDelete プロパティが true を返すと、DetailsView コントロールはデータ ソース コントロールの機能を利用して、自動削除機能を提供します。

メモ
SqlDataSourceView オブジェクトがデータを削除するためには、その基となる SqlDataSource オブジェクトの SqlDataSource.DeleteCommand プロパティに削除クエリ ステートメントが設定されていることが必要です。

AutoGenerateDeleteButton プロパティが true に設定されている場合、Delete ボタンの設定された CommandField 行フィールドが DetailsView コントロールに自動的に表示されます。Delete ボタンをクリックすると、対象のレコードはデータ ソースから永続的に削除されます。

メモ
自動削除機能が動作するようにするには、DataKeyNames プロパティも設定する必要があります。

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

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

AutoGenerateDeleteButton の値はビューステートに格納されます。

使用例

AutoGenerateDeleteButton プロパティを使用して、現在のレコードを削除するための組み込みのコントロールを表示する方法のコード例を次に示します。

Visual Basic

<%@ Page language="VB" %>

<html>
  <body>
    <form id="Form1" runat="server">
        
      <h3>DetailsView AutoGenerateDeleteButton Example</h3>
                
        <asp:detailsview id="CustomersDetailView"
          datasourceid="DetailsViewSource"
          datakeynames="CustomerID"
          autogeneratedeletebutton="true"  
          autogeneraterows="true"
          allowpaging="true"  
          runat="server">
               
          <headerstyle backcolor="Navy"
            forecolor="White"/>
                    
        </asp:detailsview>
        
        <!-- 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="DetailsViewSource"
 runat="server" 
            ConnectionString=
              "<%$ ConnectionStrings:NorthWindConnectionString%>"
            InsertCommand="INSERT INTO [Customers]([CustomerID], 
              [CompanyName], [Address], [City], [PostalCode], [Country]) 
              VALUES (@CustomerID, @CompanyName, @Address, @City, 
              @PostalCode, @Country)"
            SelectCommand="Select [CustomerID], [CompanyName], 
              [Address], [City], [PostalCode], [Country] From 
              [Customers]">
        </asp:SqlDataSource>
    </form>
  </body>
</html>

C#

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

<html>
  <body>
    <form id="Form1" runat="server">
        
      <h3>DetailsView AutoGenerateDeleteButton Example</h3>
                
        <asp:detailsview id="CustomersDetailView"
          datasourceid="DetailsViewSource"
          datakeynames="CustomerID"
          autogeneratedeletebutton="true"  
          autogeneraterows="true"
          allowpaging="true"  
          runat="server">
               
          <headerstyle backcolor="Navy"
            forecolor="White"/>
                    
        </asp:detailsview>
        
        <!-- 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="DetailsViewSource" runat="server"
 
            ConnectionString=
              "<%$ ConnectionStrings:NorthWindConnectionString%>"
            InsertCommand="INSERT INTO [Customers]([CustomerID], 
              [CompanyName], [Address], [City], [PostalCode], [Country]) 
              VALUES (@CustomerID, @CompanyName, @Address, @City, 
              @PostalCode, @Country)"
            SelectCommand="Select [CustomerID], [CompanyName], 
              [Address], [City], [PostalCode], [Country] From 
              [Customers]">
        </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

参照

関連項目
DetailsView クラス
DetailsView メンバ
System.Web.UI.WebControls 名前空間
CommandField クラス
AutoGenerateEditButton
AutoGenerateInsertButton
DataKeyNames
ItemDeleted
ItemDeleting
SqlDataSource.DeleteCommand