GridViewDeleteEventArgs

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

GridViewDeleteEventArgs クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

RowDeleting イベントのデータを提供します。

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

Visual Basic (宣言)

Public Class GridViewDeleteEventArgs
    Inherits CancelEventArgs

Visual Basic (使用法)

Dim instance As GridViewDeleteEventArgs

C#

public class GridViewDeleteEventArgs : CancelEventArgs

C++

public ref class GridViewDeleteEventArgs :
 public CancelEventArgs

J#

public class GridViewDeleteEventArgs extends
 CancelEventArgs

JScript

public class GridViewDeleteEventArgs extends
 CancelEventArgs

解説

GridView コントロールは、Delete ボタン (CommandName プロパティが "Delete" に設定されたボタン) がクリックされた場合に、GridView コントロールでレコードを削除する前に RowDeleting イベントを発生させます。これにより、このイベントが発生するたびにカスタム ルーチン (削除操作のキャンセルなど) を実行するイベント処理メソッドを提供できます。

GridViewDeleteEventArgs オブジェクトがイベント処理メソッドに渡されることにより、削除される行のインデックスを確認したり、削除操作をキャンセルする必要があることを示したりできます。削除操作をキャンセルするには、GridViewDeleteEventArgs オブジェクトの Cancel プロパティを true に設定します。また、必要に応じて、値がデータ ソースに渡される前に Keys コレクションと Values コレクションを操作することもできます。

イベント処理の詳細については、「イベントの利用」を参照してください。

GridViewDeleteEventArgs のインスタンスの初期プロパティ値の一覧については、GridViewDeleteEventArgs コンストラクタのトピックを参照してください。

使用例

イベント処理メソッドに渡された GridViewDeleteEventArgs オブジェクトを使用して、ユーザーが GridView コントロールの最後のレコードを削除しようとしたときに削除操作をキャンセルする方法を次の例に示します。

Visual Basic

<%@ Page language="VB" %>

<script runat="server">

  Sub CustomersGridView_RowDeleting(ByVal sender
 As Object, ByVal e As
 GridViewDeleteEventArgs)
      
    ' Cancel the delete operation if the user attempts to remove
    ' the last record from the GridView control.
    If CustomersGridView.Rows.Count <= 1 Then
        
      e.Cancel = True
      Message.Text = "You must keep at least one record."
            
    End If
    
  End Sub

</script>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView RowDeleting Example</h3>
            
      <asp:label id="Message"
        forecolor="Red"          
        runat="server"/>
                
      <br/>
            
      <!-- 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"
        datakeynames="CustomerID"
        onrowdeleting="CustomersGridView_RowDeleting"
  
        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]"
        deletecommand="Delete from Customers where CustomerID
 = @CustomerID"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
      
    </form>
  </body>
</html>

C#

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

<script runat="server">

  void CustomersGridView_RowDeleting(Object sender, GridViewDeleteEventArgs
 e)
  {
    
    // Cancel the delete operation if the user attempts to remove
    // the last record from the GridView control.
    if (CustomersGridView.Rows.Count <= 1)
    {
        
      e.Cancel = true;
      Message.Text = "You must keep at least one record.";
            
    }
    
  }  

</script>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView RowDeleting Example</h3>
            
      <asp:label id="Message"
        forecolor="Red"          
        runat="server"/>
                
      <br/>
            
      <!-- 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"
        datakeynames="CustomerID"
        onrowdeleting="CustomersGridView_RowDeleting"  
        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]"
        deletecommand="Delete from Customers where CustomerID = @CustomerID"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
      
    </form>
  </body>
</html>

.NET Framework のセキュリティ

• AspNetHostingPermission  ホスト環境での動作に必要なアクセス許可。要求値 : LinkDemand; アクセス許可値 : Minimal。
• AspNetHostingPermission  ホスト環境での動作に必要なアクセス許可。要求値 : InheritanceDemand; アクセス許可値 : Minimal。

継承階層

System.Object
   System.EventArgs
     System.ComponentModel.CancelEventArgs
      System.Web.UI.WebControls.GridViewDeleteEventArgs

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

参照

関連項目
GridViewDeleteEventArgs メンバ
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewDeleteEventHandler
GridView.RowDeleting イベント
その他の技術情報
イベントの利用

GridViewDeleteEventArgs コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

GridViewDeleteEventArgs クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    rowIndex As Integer _
)

Visual Basic (使用法)

Dim rowIndex As Integer

Dim instance As New GridViewDeleteEventArgs(rowIndex)

C#

public GridViewDeleteEventArgs (
    int rowIndex
)

C++

public:
GridViewDeleteEventArgs (
    int rowIndex
)

J#

public GridViewDeleteEventArgs (
    int rowIndex
)

JScript

public function GridViewDeleteEventArgs (
    rowIndex : int
)

パラメータ

rowIndex

イベントを発生させた Delete ボタンが格納されている行のインデックス。

解説

このコンストラクタを使用して、GridViewDeleteEventArgs クラスの新しいインスタンスを初期化します。

GridViewDeleteEventArgs のインスタンスの初期プロパティ値を次の表に示します。

プロパティ	初期値
RowIndex	rowIndex パラメータの値。

メモ
このコンストラクタは、主にコントロールの開発者がイベントを発生させる場合に使用します。

プラットフォーム

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

参照

関連項目
GridViewDeleteEventArgs クラス
GridViewDeleteEventArgs メンバ
System.Web.UI.WebControls 名前空間
RowIndex

GridViewDeleteEventArgs プロパティ

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。 ( CancelEventArgs から継承されます。)
	Keys	削除する行の主キーを表すフィールドの名前と値のペアのディクショナリを取得します。
	RowIndex	削除される行のインデックスを取得します。
	Values	削除する行のキー以外のフィールドの名前と値のペアのディクショナリを取得します。

参照

関連項目

GridViewDeleteEventArgs クラス
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewDeleteEventHandler
GridView.RowDeleting イベント

その他の技術情報

イベントの利用

GridViewDeleteEventArgs メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

GridViewDeleteEventArgs クラス
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewDeleteEventHandler
GridView.RowDeleting イベント

その他の技術情報

イベントの利用

GridViewDeleteEventArgs メンバ

RowDeleting イベントのデータを提供します。

GridViewDeleteEventArgs データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	GridViewDeleteEventArgs	GridViewDeleteEventArgs クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。(CancelEventArgs から継承されます。)
	Keys	削除する行の主キーを表すフィールドの名前と値のペアのディクショナリを取得します。
	RowIndex	削除される行のインデックスを取得します。
	Values	削除する行のキー以外のフィールドの名前と値のペアのディクショナリを取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

GridViewDeleteEventArgs クラス
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewDeleteEventHandler
GridView.RowDeleting イベント

その他の技術情報

イベントの利用