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)取得するときにメソッドに渡します。

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

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

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

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

重要

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

コンストラクター

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

プロパティ

Empty	並べ替え式が DataSourceSelectArguments に設定された Empty オブジェクトを取得します。
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