GridViewUpdateEventArgsとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

GridViewUpdateEventArgs クラス

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

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

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

Visual Basic (宣言)

Public Class GridViewUpdateEventArgs
    Inherits CancelEventArgs

Visual Basic (使用法)

Dim instance As GridViewUpdateEventArgs

public class GridViewUpdateEventArgs : CancelEventArgs

C++

public ref class GridViewUpdateEventArgs :
 public CancelEventArgs

public class GridViewUpdateEventArgs extends
 CancelEventArgs

JScript

public class GridViewUpdateEventArgs extends
 CancelEventArgs

解説

GridView コントロールは、行の Update ボタンがクリックされた場合に、GridView コントロールで行を更新する前に RowUpdating イベントを発生させます。これにより、このイベントが発生するたびにカスタムルーチン (更新操作のキャンセルなど) を実行するイベント処理メソッドを提供できます。

GridViewUpdateEventArgs オブジェクトがイベント処理メソッドに渡されることにより、現在の行のインデックスを確認したり、更新操作をキャンセルする必要があることを示したりできます。更新操作をキャンセルするには、GridViewUpdateEventArgs オブジェクトの Cancel プロパティを true に設定します。また、必要に応じて、値がデータソースに渡される前に Keys、OldValues、および NewValues の各コレクションを操作することもできます。これらのコレクションは、ユーザーが入力した値をデータソースに格納する前に HTML エンコードする場合によく使用されます。これは、スクリプト注入攻撃を防ぐために役立ちます。

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

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

使用例

イベント処理メソッドに渡された GridViewUpdateEventArgs オブジェクトを使用して、ユーザーが入力したすべての値をデータソースの更新前に HTML エンコードする方法を次の例に示します。

Visual Basic

<%@ Page language="VB" %>

<script runat="server">

  Sub CustomersGridView_RowUpdating(ByVal sender
 As Object, ByVal e As
 GridViewUpdateEventArgs)
    
    ' Use the CopyTo method to copy the DictionaryEntry objects in the
 
    ' NewValues collection to an array.
    Dim records(e.NewValues.Count - 1) As DictionaryEntry
    e.NewValues.CopyTo(records, 0)
    
    ' Iterate through the array and HTML encode all user-provided values
 
    ' before updating the data source.
    Dim entry As DictionaryEntry
    For Each entry In records
            
      e.NewValues(entry.Key) = Server.HtmlEncode(entry.Value.ToString())
      
    Next
        
  End Sub
       
</script>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView RowUpdating 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"
        autogenerateeditbutton="true"
        allowpaging="true" 
        datakeynames="CustomerID"
        onrowupdating="CustomersGridView_RowUpdating"
  
        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)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

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

<script runat="server">

  void CustomersGridView_RowUpdating(Object sender, GridViewUpdateEventArgs
 e)
  {
     
    // Iterate through the NewValues collection and HTML encode all
 
    // user-provided values before updating the data source.
    foreach (DictionaryEntry entry in e.NewValues)
    {
    
      e.NewValues[entry.Key] = Server.HtmlEncode(entry.Value.ToString());
    
    }
        
  }
       
</script>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView RowUpdating 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"
        autogenerateeditbutton="true"
        allowpaging="true" 
        datakeynames="CustomerID"
        onrowupdating="CustomersGridView_RowUpdating"  
        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)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

.NET Framework のセキュリティ

AspNetHostingPermission (ホスト環境で GridViewUpdateEventArgs オブジェクトを使用するために必要なアクセス許可)AspNetHostingPermissionLevel.Minimal (関連する列挙値)

継承階層

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

スレッドセーフ

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

参照

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

GridViewUpdateEventArgs コンストラクタ

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

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

名前空間: 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 GridViewUpdateEventArgs(rowIndex)

public GridViewUpdateEventArgs (
    int rowIndex
)

C++

public:
GridViewUpdateEventArgs (
    int rowIndex
)

public GridViewUpdateEventArgs (
    int rowIndex
)

JScript

public function GridViewUpdateEventArgs (
    rowIndex : int
)

パラメータ

rowIndex: 更新される行のインデックス。

解説

このコンストラクタは、指定した行インデックスを使用して GridViewUpdateEventArgs クラスの新しいインスタンスを初期化するために使用します。

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

プロパティ	初期値
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
サポート対象 : 2.0

参照

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

GridViewUpdateEventArgs プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。 ( CancelEventArgs から継承されます。)
	Keys	更新する行の主キーを表すフィールドの名前と値のペアのディクショナリを取得します。
	NewValues	更新する行のキー以外のフィールドの名前と値のペアの改訂後の値が格納されているディクショナリを取得します。
	OldValues	更新する行の元のフィールドの名前と値のペアが格納されているディクショナリを取得します。
	RowIndex	更新される行インデックスを取得します。

参照

その他の技術情報

イベントの利用

GridViewUpdateEventArgs メソッド

パブリックメソッドパブリックメソッド

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

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

プロテクトメソッド

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

参照

その他の技術情報

イベントの利用

GridViewUpdateEventArgs メンバ

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

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

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

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

パブリックプロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。(CancelEventArgs から継承されます。)
	Keys	更新する行の主キーを表すフィールドの名前と値のペアのディクショナリを取得します。
	NewValues	更新する行のキー以外のフィールドの名前と値のペアの改訂後の値が格納されているディクショナリを取得します。
	OldValues	更新する行の元のフィールドの名前と値のペアが格納されているディクショナリを取得します。
	RowIndex	更新される行インデックスを取得します。

パブリックメソッド

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

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

プロテクトメソッド

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