GridViewSelectEventArgs クラス
メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。 SelectedIndexChanging イベントのデータを提供します。
名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文
解説
使用例
.NET Framework のセキュリティ
継承階層
スレッド セーフ
プラットフォーム
バージョン情報
参照
アセンブリ: System.Web (system.web.dll 内)
構文解説GridView コントロールは、Select ボタン (CommandName プロパティが "Select" に設定されたボタン) がクリックされた場合に、GridView コントロールで選択操作を処理する前に SelectedIndexChanging イベントを発生させます。これにより、このイベントが発生するたびにカスタム ルーチン (選択操作のキャンセルなど) を実行するイベント処理メソッドを提供できます。
GridViewSelectEventArgs オブジェクトがイベント処理メソッドに渡されることにより、ユーザーが選択した行のインデックスを確認したり、選択操作をキャンセルする必要があることを示したりできます。選択操作をキャンセルするには、GridViewSelectEventArgs オブジェクトの Cancel プロパティを true に設定します。
イベント処理の詳細については、「イベントの利用」を参照してください。
GridViewSelectEventArgs のインスタンスの初期プロパティ値の一覧については、GridViewSelectEventArgs コンストラクタのトピックを参照してください。
使用例イベント処理メソッドに渡された GridViewSelectEventArgs オブジェクトを使用して、ユーザーが White という姓の作成者を選択した場合に GridView コントロールの選択操作をキャンセルする方法を次の例に示します。
<%@ 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>
<%@ 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 のセキュリティ継承階層
System.Object
System.EventArgs
System.ComponentModel.CancelEventArgs
System.Web.UI.WebControls.GridViewSelectEventArgs
System.EventArgs
System.ComponentModel.CancelEventArgs
System.Web.UI.WebControls.GridViewSelectEventArgs
スレッド セーフプラットフォーム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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照- GridViewSelectEventArgs クラスのページへのリンク
