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

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

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

GridViewSortEventArgs クラス

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

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

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

Visual Basic (宣言)

Public Class GridViewSortEventArgs
    Inherits CancelEventArgs

Visual Basic (使用法)

Dim instance As GridViewSortEventArgs

public class GridViewSortEventArgs : CancelEventArgs

C++

public ref class GridViewSortEventArgs : public
 CancelEventArgs

public class GridViewSortEventArgs extends
 CancelEventArgs

JScript

public class GridViewSortEventArgs extends
 CancelEventArgs

解説

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

メモ
CommandName プロパティが "Sort" に設定された GridView コントロール内のすべてのボタンは Sorting イベントを発生させますが、一般的に Sort ボタンは GridView コントロールのヘッダー行に表示されます。

GridViewSortEventArgs オブジェクトがイベント処理メソッドに渡されることにより、GridView コントロールの並べ替えに使用する並べ替え式や並べ替えの方向を指定または確認できます。並べ替え式を確認するには、SortExpression プロパティを使用します。並べ替えの方向を確認するには、SortDirection プロパティを使用します。Cancel プロパティを true に設定して、並べ替え操作をキャンセルすることもできます。

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

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

使用例

イベント処理メソッドに渡された GridViewSortEventArgs オブジェクトを使用して、ユーザーが GridView コントロール内の Contract 列を並べ替えようとしたときに並べ替え操作をキャンセルする方法を次の例に示します。

Visual Basic

<%@ 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 のセキュリティ

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

継承階層

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

スレッドセーフ

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

参照

関連項目
GridViewSortEventArgs メンバ
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewSortEventHandler
GridView.AllowSorting プロパティ
GridView.Sorted イベント
GridView.Sorting イベント
その他の技術情報
イベントの利用

GridViewSortEventArgs コンストラクタ

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

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

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

Visual Basic (宣言)

Public Sub New ( _
    sortExpression As String, _
    sortDirection As SortDirection _
)

Visual Basic (使用法)

Dim sortExpression As String
Dim sortDirection As SortDirection

Dim instance As New GridViewSortEventArgs(sortExpression,
 sortDirection)

public GridViewSortEventArgs (
    string sortExpression,
    SortDirection sortDirection
)

C++

public:
GridViewSortEventArgs (
    String^ sortExpression, 
    SortDirection sortDirection
)

public GridViewSortEventArgs (
    String sortExpression, 
    SortDirection sortDirection
)

JScript

public function GridViewSortEventArgs (
    sortExpression : String, 
    sortDirection : SortDirection
)

パラメータ

sortExpression: コントロール内の項目の並べ替えに使用する並べ替え式。

sortDirection: コントロール内の項目を並べ替える方向を指定する SortDirection。

解説

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

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

プロパティ	初期値
SortDirection	sortDirection パラメータの値。
SortExpression	sortExpression パラメータの値。

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

プラットフォーム

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

参照

関連項目
GridViewSortEventArgs クラス
GridViewSortEventArgs メンバ
System.Web.UI.WebControls 名前空間
SortDirection
SortExpression

GridViewSortEventArgs プロパティ

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

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。 ( CancelEventArgs から継承されます。)
	SortDirection	GridView コントロールを並べ替える方向を取得または設定します。
	SortExpression	GridView コントロール内の項目の並べ替えに使用する式を取得または設定します。

参照

その他の技術情報

イベントの利用

GridViewSortEventArgs メソッド

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

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

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

プロテクトメソッド

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

参照

その他の技術情報

イベントの利用

GridViewSortEventArgs メンバ

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

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

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

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

パブリックプロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。(CancelEventArgs から継承されます。)
	SortDirection	GridView コントロールを並べ替える方向を取得または設定します。
	SortExpression	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 から継承されます。)