DataSourceSelectArguments DataSourceSelectArguments DataSourceSelectArguments DataSourceSelectArguments Class

定義

データが取得されるとき、データ ソース コントロールからデータ関連の操作を要求するためにデータ バインド コントロールで使用する機構を提供します。Provides a mechanism that data-bound controls use to request data-related operations from data source controls when data is retrieved. このクラスは継承できません。This class cannot be inherited.

public ref class DataSourceSelectArguments sealed
public sealed class DataSourceSelectArguments
type DataSourceSelectArguments = class
Public NotInheritable Class DataSourceSelectArguments
継承
DataSourceSelectArgumentsDataSourceSelectArgumentsDataSourceSelectArgumentsDataSourceSelectArguments

注釈

データバインドコントロールはDataSourceSelectArgumentsクラスを使用して、データソースコントロールが、データの並べ替えやデータの特定のサブセットの取得など、結果セットに対して追加のデータ関連操作を実行するように要求します。Data-bound controls use the DataSourceSelectArguments class to request that a data source control performs additional data-related operations on a result set, such as sorting the data or returning a specific subset of data. これらのデータ関連の操作は、 DataSourceCapabilities列挙体によって列挙されます。These data-related operations are enumerated by the DataSourceCapabilities enumeration. 次の表は、クラスDataSourceSelectArgumentsがこれらのデータに関連する操作をサポートする方法を示しています。The following table indicates how the DataSourceSelectArguments class supports these data-related operations.

機能Capability 関連する DataSourceSelectArguments のプロパティRelated DataSourceSelectArguments properties
DataSourceCapabilities.Sort SortExpression
DataSourceCapabilities.Page StartRowIndexMaximumRowsStartRowIndex, MaximumRows
DataSourceCapabilities.RetrieveTotalRowCount RetrieveTotalRowCountTotalRowCountRetrieveTotalRowCount, TotalRowCount

データバインドコントロールは、メソッドをPerformSelect明示的に呼び出してデータをバインドSelect(DataSourceSelectArguments, DataSourceViewSelectCallback)します。これは、関連付けられているデータソースコントロールのメソッドを呼び出します。Data-bound controls explicitly call the PerformSelect method to bind data, which calls the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method of the data source control they are associated with. このようにして、データバインドコントロールは、必要に応じてデータソースコントロールからデータを取得します。In this way, the data-bound control retrieves data from the data source control on demand. メソッドはSelect(DataSourceSelectArguments, DataSourceViewSelectCallback)パラメーターをDataSourceSelectArguments受け入れるため、データバインドコントロールは、オブジェクトをDataSourceSelectArguments作成および管理し、データソースコントロールからデータをSelect(DataSourceSelectArguments, DataSourceViewSelectCallback)取得するときにメソッドに渡す役割を担います。Because the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method accepts a DataSourceSelectArguments parameter, the data-bound control is responsible for creating and managing a DataSourceSelectArguments object and passing it to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method when it retrieves data from the data source control.

場合によっては、データバインドコントロールにデータ関連の追加機能が必要ないことがあります。In some cases, data-bound controls might not need any additional data-related capabilities. この場合、データバインドコントロールは、 Empty引数オブジェクトをSelect(DataSourceSelectArguments, DataSourceViewSelectCallback)メソッドに渡します。In this case, data-bound controls pass an Empty arguments object to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method.

並べ替えられた結果セットの場合、データバインドコントロールは、実行CanSort時にデータソースビューのプロパティをDataSourceCapabilities.Sort確認し、 AddSupportedCapabilities(DataSourceCapabilities)メソッドを使用して機能を追加します。For sorted result sets, data-bound controls check a data source view's CanSort property at run time, and add a DataSourceCapabilities.Sort capability using the AddSupportedCapabilities(DataSourceCapabilities) method. 別の操作として、データバインドコントロールは、 SortExpression Select(DataSourceSelectArguments, DataSourceViewSelectCallback)メソッドに渡されるDataSourceSelectArgumentsオブジェクトのプロパティを設定することによって、データソースコントロールから並べ替えられた結果セットを要求できます。As a separate operation, the data-bound control can request a sorted result set from a data source control by setting the SortExpression property on the DataSourceSelectArguments object passed to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method.

ページングのシナリオでは、データバインドコントロールは、実行時にCanPageデータソースビューのプロパティを確認しDataSourceCapabilities.PageAddSupportedCapabilities(DataSourceCapabilities)メソッドを使用して機能を追加します。For paging scenarios, data-bound controls check a data source view's CanPage property at run time, and add a DataSourceCapabilities.Page capability using the AddSupportedCapabilities(DataSourceCapabilities) method. 別の操作として、データバインドコントロールStartRowIndexは、 Select(DataSourceSelectArguments, DataSourceViewSelectCallback)メソッドに渡されたDataSourceSelectArgumentsオブジェクトのプロパティとMaximumRowsプロパティを設定することにより、データソースコントロールからのデータのサブセットをページング用に要求できます。As a separate operation, the data-bound control can request a subset of data from a data source control for paging by setting the StartRowIndex and MaximumRows properties on the DataSourceSelectArguments object passed to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method.

ページングシナリオの合計行数を取得するために、データバインドコントロールは、実行時にデータCanRetrieveTotalRowCountソースビューのプロパティを確認し、 DataSourceCapabilities.RetrieveTotalRowCount AddSupportedCapabilities(DataSourceCapabilities)メソッドを使用して機能を追加します。To retrieve a total row count for paging scenarios, data-bound controls check a data source view's CanRetrieveTotalRowCount property at run time, and add a DataSourceCapabilities.RetrieveTotalRowCount capability using the AddSupportedCapabilities(DataSourceCapabilities) method. 別の操作として、データバインドコントロールは、 RetrieveTotalRowCount Select(DataSourceSelectArguments, DataSourceViewSelectCallback)メソッドに渡されたDataSourceSelectArgumentsオブジェクトのプロパティを設定することにより、データソースコントロールからの合計行数をページング用に要求できます。As a separate operation, the data-bound control can request a total row count from a data source control for paging by setting the RetrieveTotalRowCount property on the DataSourceSelectArguments object passed to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method. メソッドからSelect(DataSourceSelectArguments, DataSourceViewSelectCallback)制御が戻るときに、合計行数がTotalRowCountプロパティに含まれています。When the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method returns, the total row count is contained by the TotalRowCount property.

重要

いずれかのDataSourceSelectArgumentsプロパティが設定されていても、現在バインドされているデータソースコントロールが要求された機能DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView)をサポートしていない場合InvalidOperationException 、メソッドが呼び出されると例外がスローされます。If any of the DataSourceSelectArguments properties are set, but the currently bound data source control does not support the requested capability, an InvalidOperationException exception is thrown when the DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) method is called.

コンストラクター

DataSourceSelectArguments() DataSourceSelectArguments() DataSourceSelectArguments() DataSourceSelectArguments()

DataSourceSelectArguments クラスの新しい既定のインスタンスを初期化します。Initializes a new default instance of the DataSourceSelectArguments class.

DataSourceSelectArguments(Int32, Int32) DataSourceSelectArguments(Int32, Int32) DataSourceSelectArguments(Int32, Int32) DataSourceSelectArguments(Int32, Int32)

ページングのために、指定された開始位置および返す行数を使用して、DataSourceSelectArguments クラスの新しいインスタンスを初期化します。Initializes a new instance of the DataSourceSelectArguments class with the specified starting position and number of rows to return for paging scenarios.

DataSourceSelectArguments(String) DataSourceSelectArguments(String) DataSourceSelectArguments(String) DataSourceSelectArguments(String)

指定した並べ替え式で、DataSourceSelectArguments クラスの新しいインスタンスを初期化します。Initializes a new instance of the DataSourceSelectArguments class with the specified sort expression.

DataSourceSelectArguments(String, Int32, Int32) DataSourceSelectArguments(String, Int32, Int32) DataSourceSelectArguments(String, Int32, Int32) DataSourceSelectArguments(String, Int32, Int32)

ページングのために、指定された並べ替え式、開始位置、および返す行数を使用して、DataSourceSelectArguments クラスの新しいインスタンスを初期化します。Initializes a new instance of the DataSourceSelectArguments class with the specified sort expression, starting position, and number of rows to return for paging scenarios.

プロパティ

Empty Empty Empty Empty

並べ替え式が DataSourceSelectArguments に設定された Empty オブジェクトを取得します。Gets a DataSourceSelectArguments object with the sort expression set to Empty.

MaximumRows MaximumRows MaximumRows MaximumRows

データ取得操作でデータ ソース コントロールから返されるデータ行の最大数を表す値を取得または設定します。Gets or sets a value that represents the maximum number of data rows that a data source control returns for a data retrieval operation.

RetrieveTotalRowCount RetrieveTotalRowCount RetrieveTotalRowCount RetrieveTotalRowCount

データ ソース コントロールで、データ取得操作の実行中にデータ行の合計数を取得する必要があるかどうかを示す値を取得または設定します。Gets or sets a value indicating whether a data source control should retrieve a count of all the data rows during a data retrieval operation.

SortExpression SortExpression SortExpression SortExpression

Select(DataSourceSelectArguments, DataSourceViewSelectCallback) メソッドにより取得されたデータを並べ替えるためにデータ ソース ビューで使用する式を取得または設定します。Gets or sets an expression that the data source view uses to sort the data retrieved by the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method.

StartRowIndex StartRowIndex StartRowIndex StartRowIndex

データ取得操作中にデータ行を取得するときにデータ ソース コントロールで使用する開始位置を表す値を取得または設定します。Gets or sets a value that represents the starting position the data source control should use when retrieving data rows during a data retrieval operation.

TotalRowCount TotalRowCount TotalRowCount TotalRowCount

データ取得操作で取得される行の数を取得または設定します。Gets or sets the number of rows retrieved during a data retrieval operation.

メソッド

AddSupportedCapabilities(DataSourceCapabilities) AddSupportedCapabilities(DataSourceCapabilities) AddSupportedCapabilities(DataSourceCapabilities) AddSupportedCapabilities(DataSourceCapabilities)

DataSourceSelectArguments インスタンスに機能を 1 つ追加します。この機能は、サポートされている機能と要求される機能を比較するために使用されます。Adds one capability to the DataSourceSelectArguments instance, which is used to compare supported capabilities and requested capabilities.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定した DataSourceSelectArguments インスタンスが、現在のインスタンスと等しいかどうかを判断します。Determines whether the specified DataSourceSelectArguments instance is equal to the current instance.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

DataSourceSelectArguments 型のハッシュ コードを返します。Returns the hash code for the DataSourceSelectArguments type.

GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
RaiseUnsupportedCapabilitiesError(DataSourceView) RaiseUnsupportedCapabilitiesError(DataSourceView) RaiseUnsupportedCapabilitiesError(DataSourceView) RaiseUnsupportedCapabilitiesError(DataSourceView)

ExecuteSelect(DataSourceSelectArguments) 操作に対して要求される機能と、指定したデータ ソース ビューでサポートされている機能を比較します。Compares the capabilities requested for an ExecuteSelect(DataSourceSelectArguments) operation against those that the specified data source view supports.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

こちらもご覧ください