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

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

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

GridViewEditEventArgs クラス

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

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

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

Visual Basic (宣言)

Public Class GridViewEditEventArgs
    Inherits CancelEventArgs

Visual Basic (使用法)

Dim instance As GridViewEditEventArgs

public class GridViewEditEventArgs : CancelEventArgs

C++

public ref class GridViewEditEventArgs : public
 CancelEventArgs

public class GridViewEditEventArgs extends
 CancelEventArgs

JScript

public class GridViewEditEventArgs extends
 CancelEventArgs

解説

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

GridViewEditEventArgs オブジェクトがイベント処理メソッドに渡されることにより、編集される行のインデックスを確認したり、編集をキャンセルする必要があることを示したりできます。編集操作をキャンセルするには、GridViewEditEventArgs オブジェクトの Cancel プロパティを true に設定します。

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

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

使用例

イベント処理メソッドに渡された GridViewEditEventArgs オブジェクトを使用して、White という姓の作成者が格納されている行をユーザーが編集しようとした場合に編集操作をキャンセルする方法を次の例に示します。

Visual Basic

<%@ Page language="VB" %>

<script runat="server">

  Sub CustomersGridView_RowEditing(ByVal sender
 As Object, ByVal e As
 GridViewEditEventArgs)
        
    ' Get the country for the row being edited. For this example, the
    ' country is contained in the seventh column (index 6). 
    Dim country As String
 = CustomersGridView.Rows(e.NewEditIndex).Cells(6).Text

    ' For this example, cancel the edit operation if the user attempts
    ' to edit the record of a customer from the United States. 
    If country = "USA" Then
    
      ' Cancel the edit operation.
      e.Cancel = True
      Message.Text = "You cannot edit this record."
     
    Else
      
      Message.Text = ""
      
    End If
    
  End Sub
    
</script>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView RowEditing 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"
        autogenerateeditbutton="true"
        allowpaging="true" 
        datakeynames="CustomerID"
        onrowediting="CustomersGridView_RowEditing"
   
        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_RowEditing(Object sender, GridViewEditEventArgs
 e)
  {
    
    // Get the country for the row being edited. For this example, the
    // country is contained in the seventh column (index 6). 
    String country = CustomersGridView.Rows[e.NewEditIndex].Cells[6].Text;

    // For this example, cancel the edit operation if the user attempts
    // to edit the record of a customer from the Unites States. 
    if (country == "USA")
    {
      // Cancel the edit operation.
      e.Cancel = true;
      Message.Text = "You cannot edit this record.";
    }
    else
    {
      Message.Text = "";
    }
    
  }
    
</script>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView RowEditing 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"
        autogenerateeditbutton="true"
        allowpaging="true" 
        datakeynames="CustomerID"
        onrowediting="CustomersGridView_RowEditing"   
        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 (ホスト環境での動作に必要なアクセス許可)要求値 : LinkDemand; アクセス許可値 : Minimal。
AspNetHostingPermission (ホスト環境での動作に必要なアクセス許可)要求値 : InheritanceDemand; アクセス許可値 : Minimal。

継承階層

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

スレッドセーフ

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

参照

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

GridViewEditEventArgs コンストラクタ

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

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

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

Visual Basic (宣言)

Public Sub New ( _
    newEditIndex As Integer _
)

Visual Basic (使用法)

Dim newEditIndex As Integer

Dim instance As New GridViewEditEventArgs(newEditIndex)

public GridViewEditEventArgs (
    int newEditIndex
)

C++

public:
GridViewEditEventArgs (
    int newEditIndex
)

public GridViewEditEventArgs (
    int newEditIndex
)

JScript

public function GridViewEditEventArgs (
    newEditIndex : int
)

パラメータ

newEditIndex: 編集する行のインデックス。

解説

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

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

プロパティ	初期値
NewEditIndex	newEditIndex パラメータの値。

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

プラットフォーム

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

参照

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

GridViewEditEventArgs プロパティ

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

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。 ( CancelEventArgs から継承されます。)
	NewEditIndex	編集される行のインデックスを取得または設定します。

参照

その他の技術情報

イベントの利用

GridViewEditEventArgs メソッド

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

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

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

プロテクトメソッド

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

参照

その他の技術情報

イベントの利用

GridViewEditEventArgs メンバ

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

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

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

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

パブリックプロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。(CancelEventArgs から継承されます。)
	NewEditIndex	編集される行のインデックスを取得または設定します。

パブリックメソッド

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

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

プロテクトメソッド

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