DataSourceSelectArguments クラス

定義

名前空間:

System.Web.UI

アセンブリ:

System.Web.dll

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

public ref class DataSourceSelectArguments sealed

public sealed class DataSourceSelectArguments

type DataSourceSelectArguments = class

Public NotInheritable Class DataSourceSelectArguments

継承

Object

DataSourceSelectArguments

注釈

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

力	関連する DataSourceSelectArguments プロパティ
DataSourceCapabilities.Sort	SortExpression
DataSourceCapabilities.Page	StartRowIndex、MaximumRows
DataSourceCapabilities.RetrieveTotalRowCount	RetrieveTotalRowCount、TotalRowCount

データ バインド コントロールは、PerformSelect メソッドを明示的に呼び出してデータをバインドし、関連付けられているデータ ソース コントロールの Select(DataSourceSelectArguments, DataSourceViewSelectCallback) メソッドを呼び出します。 このようにして、データ バインド コントロールは、データ ソース コントロールから必要に応じてデータを取得します。 Select(DataSourceSelectArguments, DataSourceViewSelectCallback) メソッドは DataSourceSelectArguments パラメーターを受け取るため、データ バインド コントロールは、データ ソース コントロールからデータを取得するときに、DataSourceSelectArguments オブジェクトを作成して管理し、Select(DataSourceSelectArguments, DataSourceViewSelectCallback) メソッドに渡す役割を担います。

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

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

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

ページング シナリオの合計行数を取得するために、データ バインド コントロールは実行時にデータ ソース ビューの CanRetrieveTotalRowCount プロパティをチェックし、AddSupportedCapabilities(DataSourceCapabilities) メソッドを使用して DataSourceCapabilities.RetrieveTotalRowCount 機能を追加します。 別の操作として、データ バインド コントロールは、Select(DataSourceSelectArguments, DataSourceViewSelectCallback) メソッドに渡された DataSourceSelectArguments オブジェクトの RetrieveTotalRowCount プロパティを設定することで、ページングのためにデータ ソース コントロールに合計行数を要求できます。 Select(DataSourceSelectArguments, DataSourceViewSelectCallback) メソッドから制御が戻ると、TotalRowCount プロパティに合計行数が含まれます。

大事な

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

コンストラクター

DataSourceSelectArguments()	DataSourceSelectArguments クラスの新しい既定のインスタンスを初期化します。
DataSourceSelectArguments(Int32, Int32)	ページング シナリオで返す開始位置と行数を指定して、DataSourceSelectArguments クラスの新しいインスタンスを初期化します。
DataSourceSelectArguments(String, Int32, Int32)	指定した並べ替え式、開始位置、ページング シナリオで返す行数を使用して、DataSourceSelectArguments クラスの新しいインスタンスを初期化します。
DataSourceSelectArguments(String)	指定した並べ替え式を使用して、DataSourceSelectArguments クラスの新しいインスタンスを初期化します。

プロパティ

Empty	並べ替え式が Emptyに設定された DataSourceSelectArguments オブジェクトを取得します。
MaximumRows	データ取得操作でデータ ソース コントロールが返すデータ行の最大数を表す値を取得または設定します。
RetrieveTotalRowCount	データ 取得操作中にデータ ソース コントロールがすべてのデータ行の数を取得する必要があるかどうかを示す値を取得または設定します。
SortExpression	Select(DataSourceSelectArguments, DataSourceViewSelectCallback) メソッドによって取得されたデータの並べ替えにデータ ソース ビューが使用する式を取得または設定します。
StartRowIndex	データ取得操作中にデータ行を取得するときにデータ ソース コントロールが使用する開始位置を表す値を取得または設定します。
TotalRowCount	データ取得操作中に取得された行の数を取得または設定します。

メソッド

AddSupportedCapabilities(DataSourceCapabilities)	DataSourceSelectArguments インスタンスに 1 つの機能を追加します。この機能は、サポートされている機能と要求された機能を比較するために使用されます。
Equals(Object)	指定した DataSourceSelectArguments インスタンスが現在のインスタンスと等しいかどうかを判断します。
GetHashCode()	DataSourceSelectArguments 型のハッシュ コードを返します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
RaiseUnsupportedCapabilitiesError(DataSourceView)	ExecuteSelect(DataSourceSelectArguments) 操作に対して要求された機能と、指定したデータ ソース ビューでサポートされている機能を比較します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

こちらもご覧ください

• DataSourceCapabilities