GridViewSelectEventArgs

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

GridViewSelectEventArgs クラス

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

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

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

Visual Basic (宣言)

Public Class GridViewSelectEventArgs
    Inherits CancelEventArgs

Visual Basic (使用法)

Dim instance As GridViewSelectEventArgs

C#

public class GridViewSelectEventArgs : CancelEventArgs

C++

public ref class GridViewSelectEventArgs :
 public CancelEventArgs

J#

public class GridViewSelectEventArgs extends
 CancelEventArgs

JScript

public class GridViewSelectEventArgs extends
 CancelEventArgs

解説

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

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

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

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

使用例

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

Visual Basic

<%@ Page language="VB" %>

<script runat="server">

  Sub CustomersGridView_SelectedIndexChanged(ByVal
 sender As Object, ByVal
 e As EventArgs)
        
    ' Get the currently selected row using the SelectedRow property.
    Dim row As GridViewRow = CustomersGridView.SelectedRow
        
    ' Display the company name from the selected row.
    ' In this example, the third column (index 2) contains
    ' the company name.
    Message.Text = "You selected " & row.Cells(2).Text
 & "."
    
  End Sub

  Sub CustomersGridView_SelectedIndexChanging(ByVal
 sender As Object, ByVal
 e As GridViewSelectEventArgs)
        
    ' Get the currently selected row. Because the SelectedIndexChanging
 event
    ' occurs before the select operation in the GridView control, the
    ' SelectedRow property cannot be used. Instead, use the Rows collection
    ' and the NewSelectedIndex property of the e argument passed to
 this 
    ' event handler.
    Dim row As GridViewRow = CustomersGridView.Rows(e.NewSelectedIndex)

    ' You can cancel the select operation by using the Cancel
    ' property. For this example, if the user selects a customer with
 
    ' the ID "ANATR", the select operation is canceled and
 an error message
    ' is displayed.
    If row.Cells(1).Text = "ANATR"
 Then
 
      e.Cancel = True
      Message.Text = "You cannot select " + row.Cells(2).Text
 & "."
      
    End If
    
  End Sub

</script>

<html>
  <body>
    <form runat="server">
        
     <h3>GridView Select Example</h3>

     <asp:gridview id="CustomersGridView" 
       datasourceid="CustomersSource" 
       autogeneratecolumns="true"
       autogenerateselectbutton="true"
       allowpaging="true" 
       selectedindex="0"
       onselectedindexchanged="CustomersGridView_SelectedIndexChanged"
       onselectedindexchanging="CustomersGridView_SelectedIndexChanging"
   
       runat="server">
                
       <selectedrowstyle backcolor="LightCyan"
         forecolor="DarkBlue"
         font-bold="true"/>  
                
     </asp:gridview>
            
      <br/>
            
      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>
            
      <!-- 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="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address],
 [City], [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
        runat="server"/>
            
    </form>
  </body>
</html>

C#

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

<script runat="server">

  void CustomersGridView_SelectedIndexChanged(Object sender, EventArgs
 e)
  {
    
    // Get the currently selected row using the SelectedRow property.
    GridViewRow row = CustomersGridView.SelectedRow;
        
    // Display the company name from the selected row.
    // In this example, the third column (index 2) contains
    // the company name.
    Message.Text = "You selected " + row.Cells[2].Text + ".";
    
  }

  void CustomersGridView_SelectedIndexChanging(Object sender,
 GridViewSelectEventArgs e)
  {
        
    // Get the currently selected row. Because the SelectedIndexChanging
 event
    // occurs before the select operation in the GridView control, the
    // SelectedRow property cannot be used. Instead, use the Rows collection
    // and the NewSelectedIndex property of the e argument passed to
 this 
    // event handler.
    GridViewRow row = CustomersGridView.Rows[e.NewSelectedIndex];

    // You can cancel the select operation by using the Cancel
    // property. For this example, if the user selects a customer with
 
    // the ID "ANATR", the select operation is canceled and
 an error message
    // is displayed.
    if (row.Cells[1].Text == "ANATR")
    {
        
      e.Cancel = true;
      Message.Text = "You cannot select " + row.Cells[2].Text + ".";
        
    }
    
  }

</script>

<html>
  <body>
    <form runat="server">
        
     <h3>GridView Select Example</h3>

     <asp:gridview id="CustomersGridView" 
       datasourceid="CustomersSource" 
       autogeneratecolumns="true"
       autogenerateselectbutton="true"
       allowpaging="true" 
       selectedindex="0"
       onselectedindexchanged="CustomersGridView_SelectedIndexChanged"
       onselectedindexchanging="CustomersGridView_SelectedIndexChanging"
   
       runat="server">
                
       <selectedrowstyle backcolor="LightCyan"
         forecolor="DarkBlue"
         font-bold="true"/>  
                
     </asp:gridview>
            
      <br/>
            
      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>
            
      <!-- 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="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City],
 [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
        runat="server"/>
            
    </form>
  </body>
</html>

.NET Framework のセキュリティ

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

継承階層

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

スレッド セーフ

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

参照

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

GridViewSelectEventArgs コンストラクタ

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

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

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

Visual Basic (宣言)

Public Sub New ( _
    newSelectedIndex As Integer _
)

Visual Basic (使用法)

Dim newSelectedIndex As Integer

Dim instance As New GridViewSelectEventArgs(newSelectedIndex)

C#

public GridViewSelectEventArgs (
    int newSelectedIndex
)

C++

public:
GridViewSelectEventArgs (
    int newSelectedIndex
)

J#

public GridViewSelectEventArgs (
    int newSelectedIndex
)

JScript

public function GridViewSelectEventArgs (
    newSelectedIndex : int
)

パラメータ

newSelectedIndex

GridView コントロールで選択する新しい行のインデックス。

解説

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

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

プロパティ	初期値
NewSelectedIndex	newSelectedIndex パラメータの値。

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

プラットフォーム

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

参照

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

GridViewSelectEventArgs プロパティ

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。 ( CancelEventArgs から継承されます。)
	NewSelectedIndex	GridView コントロールで選択する新しい行のインデックスを取得または設定します。

参照

関連項目

GridViewSelectEventArgs クラス
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewSelectEventHandler
GridView.SelectedIndexChanging イベント

その他の技術情報

イベントの利用

GridViewSelectEventArgs メソッド

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

GridViewSelectEventArgs クラス
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewSelectEventHandler
GridView.SelectedIndexChanging イベント

その他の技術情報

イベントの利用

GridViewSelectEventArgs メンバ

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

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

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

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

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。(CancelEventArgs から継承されます。)
	NewSelectedIndex	GridView コントロールで選択する新しい行のインデックスを取得または設定します。

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

GridViewSelectEventArgs クラス
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewSelectEventHandler
GridView.SelectedIndexChanging イベント

その他の技術情報

イベントの利用