DataSourceSelectArguments クラス

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

DataSourceSelectArguments クラス

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

データが取得されるとき、データ ソース コントロールからデータ関連の操作を要求するためにデータ バインド コントロールで使用する機構を提供します。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 DataSourceSelectArguments

Visual Basic (使用法)

Dim instance As DataSourceSelectArguments

C#

public sealed class DataSourceSelectArguments

C++

public ref class DataSourceSelectArguments
 sealed

J#

public final class DataSourceSelectArguments

JScript

public final class DataSourceSelectArguments

解説

データ バインド コントロールは、DataSourceSelectArguments クラスを使用して、データ ソース コントロールが結果セットに対してデータ関連の追加操作を実行するように要求します。このデータ関連の追加操作には、データの並べ替えや特定のデータのサブセットを返す操作などがあります。それらのデータ関連の操作は、DataSourceCapabilities 列挙体によって列挙されます。データ関連の操作が DataSourceSelectArguments クラスでどのようにサポートされるかを次の表に示します。

機能	DataSourceSelectArguments の関連するプロパティ
DataSourceCapabilities.Sort	SortExpression
DataSourceCapabilities.Page	StartRowIndex, MaximumRows
DataSourceCapabilities.RetrieveTotalRowCount	RetrieveTotalRowCount, TotalRowCount

データ バインド コントロールは、明示的に PerformSelect メソッドを呼び出してデータをバインドします。このメソッドでは、関連付けられているデータ ソース コントロールの Select メソッドが呼び出されます。これにより、データ バインド コントロールは要求に応じてデータ ソース コントロールからデータを取得します。Select メソッドは DataSourceSelectArguments パラメータを受け取るので、データ バインド コントロールは、DataSourceSelectArguments オブジェクトを作成および管理して、データ ソース コントロールからデータを取得するときは Select メソッドにこのオブジェクトを渡す必要があります。

場合によっては、データ バインド コントロールで追加のデータ関連機能を必要としないこともあります。その場合は、データ バインド コントロールで Select メソッドに Empty 引数オブジェクトを渡します。

並べ替えられた結果セットの場合、データ バインド コントロールでは、データ ソース ビューの CanSort プロパティを実行時にチェックし、AddSupportedCapabilities メソッドを使用して DataSourceCapabilities.Sort 機能を追加します。それとは別の操作として、データ バインド コントロールでは、並べ替えられた結果セットをデータ ソース コントロールに要求することもできます。この操作は、Select メソッドに渡される DataSourceSelectArguments オブジェクトの SortExpression プロパティを設定することによって実行できます。

ページングを使用する場合、データ バインド コントロールでは、データ ソース ビューの CanPage プロパティを実行時にチェックし、AddSupportedCapabilities メソッドを使用して DataSourceCapabilities.Page 機能を追加します。それとは別の操作として、データ バインド コントロールでは、ページングを行うデータ ソース コントロールにデータのサブセットを要求することもできます。この操作は、Select メソッドに渡される DataSourceSelectArguments オブジェクトの StartRowIndex プロパティと MaximumRows プロパティを設定することによって実行できます。

ページングを使用する場合に行の合計数を取得するには、データ バインド コントロールで、データ ソース ビューの CanRetrieveTotalRowCount プロパティを実行時にチェックし、AddSupportedCapabilities メソッドを使用して DataSourceCapabilities.RetrieveTotalRowCount 機能を追加します。それとは別の操作として、データ バインド コントロールでは、ページングを行うデータ ソース コントロールに行の合計数を要求することもできます。この操作は、Select メソッドに渡される DataSourceSelectArguments オブジェクトの RetrieveTotalRowCount プロパティを設定することによって実行できます。Select メソッドから値が返されるとき、行の合計数は TotalRowCount プロパティに格納されます。

重要 :
DataSourceSelectArguments のプロパティが設定されても、要求された機能が現在バインドされているデータ ソース コントロールでサポートされていない場合は、DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError メソッドが呼び出されたときに InvalidOperationException 例外がスローされます。

継承階層

System.Object
  System.Web.UI.DataSourceSelectArguments

スレッド セーフ

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

参照

関連項目
DataSourceSelectArguments メンバ
System.Web.UI 名前空間
DataSourceCapabilities 列挙体