GridViewSortEventArgs クラス
アセンブリ: System.Web (system.web.dll 内)
構文解説GridView コントロールは、Sort ボタン (CommandName プロパティが "Sort" に設定されたボタン) がクリックされた場合に、GridView コントロールで並べ替え操作を処理する前に Sorting イベントを発生させます。これにより、このイベントが発生するたびにカスタム ルーチン (並べ替え操作をキャンセルするなど) を実行するイベント処理メソッドを提供できます。
.gif) メモ |
|---|
| CommandName プロパティが "Sort" に設定された GridView コントロール内のすべてのボタンは Sorting イベントを発生させますが、一般的に Sort ボタンは GridView コントロールのヘッダー行に表示されます。 |
GridViewSortEventArgs オブジェクトがイベント処理メソッドに渡されることにより、GridView コントロールの並べ替えに使用する並べ替え式や並べ替えの方向を指定または確認できます。並べ替え式を確認するには、SortExpression プロパティを使用します。並べ替えの方向を確認するには、SortDirection プロパティを使用します。Cancel プロパティを true に設定して、並べ替え操作をキャンセルすることもできます。
イベント処理の詳細については、「イベントの利用」を参照してください。
GridViewSortEventArgs のインスタンスの初期プロパティ値の一覧については、GridViewSelectEventArgs コンストラクタのトピックを参照してください。
使用例イベント処理メソッドに渡された GridViewSortEventArgs オブジェクトを使用して、ユーザーが GridView コントロール内の Contract 列を並べ替えようとしたときに並べ替え操作をキャンセルする方法を次の例に示します。
<%@ Page language="VB" %> <script runat="server"> Sub CustomersGridView_Sorting(sender As Object, e As GridViewSortEventArgs) ' Cancel the sorting operation if the user attempts ' to sort by address. If e.SortExpression = "Address" Then e.Cancel = True Message.Text = "You cannot sort by address." SortInformationLabel.Text = "" Else Message.Text = "" End If End Sub Sub CustomersGridView_Sorted(ByVal sender As Object, ByVal e As EventArgs) ' Display the sort expression and sort direction. SortInformationLabel.Text = "Sorting by " & _ CustomersGridView.SortExpression.ToString() & _ " in " & CustomersGridView.SortDirection.ToString() & _ " order." End Sub </script> <html> <body> <form runat="server"> <h3>GridView Sorted and Sorting Example</h3> <asp:label id="Message" forecolor="Red" runat="server"/> <br/> <asp:label id="SortInformationLabel" forecolor="Navy" runat="server"/> <br/> <asp:gridview id="CustomersGridView" datasourceid="CustomersSource" autogeneratecolumns="true" allowpaging="true" emptydatatext="No data available." allowsorting="true" onsorting="CustomersGridView_Sorting" onsorted="CustomersGridView_Sorted" 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="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_Sorting(Object sender, GridViewSortEventArgs e) { // Cancel the sorting operation if the user attempts // to sort by address. if (e.SortExpression == "Address") { e.Cancel = true; Message.Text = "You cannot sort by address."; SortInformationLabel.Text = ""; } else { Message.Text = ""; } } void CustomersGridView_Sorted(Object sender, EventArgs e) { // Display the sort expression and sort direction. SortInformationLabel.Text = "Sorting by " + CustomersGridView.SortExpression.ToString() + " in " + CustomersGridView.SortDirection.ToString() + " order."; } </script> <html> <body> <form runat="server"> <h3>GridView Sorting Example</h3> <asp:label id="Message" forecolor="Red" runat="server"/> <br/> <asp:label id="SortInformationLabel" forecolor="Navy" runat="server"/> <br/> <asp:gridview id="CustomersGridView" datasourceid="CustomersSource" autogeneratecolumns="true" allowpaging="true" emptydatatext="No data available." allowsorting="true" onsorting="CustomersGridView_Sorting" onsorted="CustomersGridView_Sorted" 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="CustomersSource" selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]" connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" runat="server"/> </form> </body> </html>
.NET Framework のセキュリティ継承階層System.EventArgs
System.ComponentModel.CancelEventArgs
System.Web.UI.WebControls.GridViewSortEventArgs
スレッド セーフプラットフォーム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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照- GridViewSortEventArgs クラスのページへのリンク
