GridViewDeletedEventArgs

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

GridViewDeletedEventArgs クラス

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

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

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

Visual Basic (宣言)

Public Class GridViewDeletedEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As GridViewDeletedEventArgs

C#

public class GridViewDeletedEventArgs : EventArgs

C++

public ref class GridViewDeletedEventArgs :
 public EventArgs

J#

public class GridViewDeletedEventArgs extends
 EventArgs

JScript

public class GridViewDeletedEventArgs extends
 EventArgs

解説

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

GridViewDeletedEventArgs オブジェクトがイベント処理メソッドに渡されることにより、影響を受けたレコード数および発生した例外を確認できます。削除操作の影響を受けたレコード数を確認するには、AffectedRows プロパティを使用します。例外が発生しているかどうかを確認するには、Exception プロパティを使用します。ExceptionHandled プロパティを設定することにより、イベント処理メソッドで既に例外が処理されたかどうかを示すこともできます。

メモ
削除操作中に例外が発生し、ExceptionHandled プロパティが false に設定されている場合は、GridView コントロールによって例外が再度スローされます。

削除されたレコードのキー フィールドおよびキー以外のフィールドの名前と値のペアにアクセスする場合は、Keys プロパティ (名前の場合) と Values プロパティ (値の場合) を使用します。

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

使用例

RowDeleted イベントのイベント処理メソッドに渡された GridViewDeletedEventArgs オブジェクトを使用して、削除操作中に例外が発生したかどうかを確認する方法を次の例に示します。

Visual Basic

<%@ Page language="VB" %>

<script runat="server">

  Sub CustomersGridView_RowDeleted(ByVal sender
 As Object, ByVal e As
 GridViewDeletedEventArgs)

    ' Use the Exception property to determine whether an exception
    ' occurred during the delete operation.
    If e.Exception Is Nothing
 Then

      ' Use the AffectedRows property to determine whether the
      ' record was deleted. Sometimes an error might occur that 
      ' does not raise an exception, but prevents the delete
      ' operation from completing.
      If e.AffectedRows = 1 Then
      
        Message.Text = "Record deleted successfully."
      
      Else
      
        Message.Text = "An error occurred during the delete operation."
      
      End If
    
    Else
          
      ' Insert the code to handle the exception.
      Message.Text = "An error occurred during the delete operation."

      ' Use the ExceptionHandled property to indicate that the 
      ' exception is already handled.
      e.ExceptionHandled = True
    
    End If
    
  End Sub
    
</script>

<html>
  <body>
    <form runat="server">
        
      <h3>GridViewDeletedEventArgs 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"
        onrowdeleted="CustomersGridView_RowDeleted"
  
        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_RowDeleted(Object sender, GridViewDeletedEventArgs
 e)
  {

    // Use the Exception property to determine whether an exception
    // occurred during the delete operation.
    if (e.Exception == null)
    {
      // Use the AffectedRows property to determine whether the
      // record was deleted. Sometimes an error might occur that 
      // does not raise an exception, but prevents the delete
      // operation from completing.
      if (e.AffectedRows == 1)
      {
        Message.Text = "Record deleted successfully.";
      }
      else
      {
        Message.Text = "An error occurred during the delete operation.";
      }
    }
    else
    {
      // Insert the code to handle the exception.
      Message.Text = "An error occurred during the delete operation.";

      // Use the ExceptionHandled property to indicate that the 
      // exception is already handled.
      e.ExceptionHandled = true;
    }
    
  }
    
</script>

<html>
  <body>
    <form runat="server">
        
      <h3>GridViewDeletedEventArgs 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"
        onrowdeleted="CustomersGridView_RowDeleted"  
        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.Web.UI.WebControls.GridViewDeletedEventArgs

スレッド セーフ

この型の 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

参照

関連項目
GridViewDeletedEventArgs メンバ
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewDeletedEventHandler
GridView.RowDeleted イベント
AffectedRows
Exception
ExceptionHandled
Keys
Values
OnRowDeleted

GridViewDeletedEventArgs コンストラクタ

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

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

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

Visual Basic (宣言)

Public Sub New ( _
    affectedRows As Integer, _
    e As Exception _
)

Visual Basic (使用法)

Dim affectedRows As Integer
Dim e As Exception

Dim instance As New GridViewDeletedEventArgs(affectedRows,
 e)

C#

public GridViewDeletedEventArgs (
    int affectedRows,
    Exception e
)

C++

public:
GridViewDeletedEventArgs (
    int affectedRows, 
    Exception^ e
)

J#

public GridViewDeletedEventArgs (
    int affectedRows, 
    Exception e
)

JScript

public function GridViewDeletedEventArgs (
    affectedRows : int, 
    e : Exception
)

パラメータ

affectedRows

削除操作の影響を受けた行の数。

e

削除操作の実行時に発生した例外を表す Exception。例外が発生しない場合は、このパラメータに null 参照 (Visual Basic では Nothing) を使用します。

解説

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

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

プロパティ	初期値
AffectedRows	affectedRows パラメータの値。
Exception	e パラメータに格納された System.Exception オブジェクト。
ExceptionHandled	false に初期化されます。

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

プラットフォーム

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

参照

関連項目
GridViewDeletedEventArgs クラス
GridViewDeletedEventArgs メンバ
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewDeletedEventHandler
Exception
GridView.RowDeleted イベント
AffectedRows
Exception
ExceptionHandled
OnRowDeleted

GridViewDeletedEventArgs プロパティ

パブリック プロパティ

	名前	説明
	AffectedRows	削除操作の影響を受けた行の数を取得します。
	Exception	削除操作中に例外が発生した場合は、その例外を取得します。
	ExceptionHandled	削除操作中に発生した例外がイベント ハンドラで処理されたかどうかを示す値を取得または設定します。
	Keys	削除されたレコードのキー フィールドの名前と値のペアの並べ替え後のディクショナリを取得します。
	Values	削除されたレコードのキー以外のフィールドの名前と値のペアのディクショナリを取得します。

参照

関連項目

GridViewDeletedEventArgs クラス
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewDeletedEventHandler
GridView.RowDeleted イベント
AffectedRows
Exception
ExceptionHandled
Keys
Values
OnRowDeleted

GridViewDeletedEventArgs メソッド

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

GridViewDeletedEventArgs クラス
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewDeletedEventHandler
GridView.RowDeleted イベント
AffectedRows
Exception
ExceptionHandled
Keys
Values
OnRowDeleted

GridViewDeletedEventArgs メンバ

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

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

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

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

パブリック プロパティ

	名前	説明
	AffectedRows	削除操作の影響を受けた行の数を取得します。
	Exception	削除操作中に例外が発生した場合は、その例外を取得します。
	ExceptionHandled	削除操作中に発生した例外がイベント ハンドラで処理されたかどうかを示す値を取得または設定します。
	Keys	削除されたレコードのキー フィールドの名前と値のペアの並べ替え後のディクショナリを取得します。
	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 から継承されます。)

参照

関連項目

GridViewDeletedEventArgs クラス
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewDeletedEventHandler
GridView.RowDeleted イベント
AffectedRows
Exception
ExceptionHandled
Keys
Values
OnRowDeleted