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 列挙体

DataSourceSelectArguments コンストラクタ ()

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

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

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New DataSourceSelectArguments

C#

public DataSourceSelectArguments ()

C++

public:
DataSourceSelectArguments ()

J#

public DataSourceSelectArguments ()

JScript

public function DataSourceSelectArguments ()

解説

既定のコンストラクタでは、SortExpression プロパティが String.Empty に初期化され、StartRowIndex プロパティと MaximumRows プロパティが 0 に初期化された状態で、クラスのインスタンスが作成されます。

プラットフォーム

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 クラス
DataSourceSelectArguments メンバ
System.Web.UI 名前空間

DataSourceSelectArguments コンストラクタ (String, Int32, Int32)

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

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

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

Visual Basic (宣言)

Public Sub New ( _
    sortExpression As String, _
    startRowIndex As Integer, _
    maximumRows As Integer _
)

Visual Basic (使用法)

Dim sortExpression As String
Dim startRowIndex As Integer
Dim maximumRows As Integer

Dim instance As New DataSourceSelectArguments(sortExpression,
 startRowIndex, maximumRows)

C#

public DataSourceSelectArguments (
    string sortExpression,
    int startRowIndex,
    int maximumRows
)

C++

public:
DataSourceSelectArguments (
    String^ sortExpression, 
    int startRowIndex, 
    int maximumRows
)

J#

public DataSourceSelectArguments (
    String sortExpression, 
    int startRowIndex, 
    int maximumRows
)

JScript

public function DataSourceSelectArguments (
    sortExpression : String, 
    startRowIndex : int, 
    maximumRows : int
)

パラメータ

sortExpression

データ取得操作の結果を呼び出し元に返す前に並べ替えるためにデータ ソース コントロールで使用する並べ替え式。

startRowIndex

データ取得操作によって返されるデータの先頭をマークする、データ行のインデックス。

maximumRows

データ取得操作によって返される最大行数。

プラットフォーム

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 クラス
DataSourceSelectArguments メンバ
System.Web.UI 名前空間

DataSourceSelectArguments コンストラクタ (String)

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

指定した並べ替え式で、DataSourceSelectArguments クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    sortExpression As String _
)

Visual Basic (使用法)

Dim sortExpression As String

Dim instance As New DataSourceSelectArguments(sortExpression)

C#

public DataSourceSelectArguments (
    string sortExpression
)

C++

public:
DataSourceSelectArguments (
    String^ sortExpression
)

J#

public DataSourceSelectArguments (
    String sortExpression
)

JScript

public function DataSourceSelectArguments (
    sortExpression : String
)

パラメータ

sortExpression

データ取得操作の結果を呼び出し元に返す前に並べ替えるためにデータ ソース コントロールで使用する並べ替え式。

解説

DataSourceSelectArguments(String) コンストラクタでは、SortExpression が指定された式で初期化され、StartRowIndex プロパティと MaximumRows プロパティが 0 に初期化された状態で、クラスのインスタンスが作成されます。

プラットフォーム

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 クラス
DataSourceSelectArguments メンバ
System.Web.UI 名前空間

DataSourceSelectArguments コンストラクタ (Int32, Int32)

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

ページングのために、指定された開始位置および返す行数を使用して、DataSourceSelectArguments クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    startRowIndex As Integer, _
    maximumRows As Integer _
)

Visual Basic (使用法)

Dim startRowIndex As Integer
Dim maximumRows As Integer

Dim instance As New DataSourceSelectArguments(startRowIndex,
 maximumRows)

C#

public DataSourceSelectArguments (
    int startRowIndex,
    int maximumRows
)

C++

public:
DataSourceSelectArguments (
    int startRowIndex, 
    int maximumRows
)

J#

public DataSourceSelectArguments (
    int startRowIndex, 
    int maximumRows
)

JScript

public function DataSourceSelectArguments (
    startRowIndex : int, 
    maximumRows : int
)

パラメータ

startRowIndex

データ取得操作によって返されるデータの先頭をマークする、データ行のインデックス。

maximumRows

データ取得操作によって返される最大行数。

解説

DataSourceSelectArguments(Int32,Int32) コンストラクタでは、SortExpression が String.Empty に初期化され、StartRowIndex プロパティと MaximumRows プロパティが startRowIndex パラメータと maximumRows パラメータで指定された値に初期化された状態で、クラスのインスタンスが作成されます。

プラットフォーム

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 クラス
DataSourceSelectArguments メンバ
System.Web.UI 名前空間

DataSourceSelectArguments コンストラクタ

DataSourceSelectArguments クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

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

参照

関連項目

DataSourceSelectArguments クラス
DataSourceSelectArguments メンバ
System.Web.UI 名前空間

DataSourceSelectArguments プロパティ

パブリック プロパティ

	名前	説明
	MaximumRows	データ取得操作でデータ ソース コントロールから返されるデータ行の最大数を表す値を取得または設定します。
	RetrieveTotalRowCount	データ ソース コントロールで、データ取得操作の実行中にデータ行の合計数を取得する必要があるかどうかを示す値を取得または設定します。
	SortExpression	DataSourceView.Select メソッドにより取得されたデータを並べ替えるためにデータ ソース ビューで使用する式を取得または設定します。
	StartRowIndex	データ取得操作中にデータ行を取得するときにデータ ソース コントロールで使用する開始位置を表す値を取得または設定します。
	TotalRowCount	データ取得操作で取得される行の数を取得または設定します。

参照

関連項目

DataSourceSelectArguments クラス
System.Web.UI 名前空間
DataSourceCapabilities 列挙体

DataSourceSelectArguments メソッド

パブリック メソッド

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

	名前	説明
	AddSupportedCapabilities	DataSourceSelectArguments インスタンスに機能を 1 つ追加します。この機能は、サポートされている機能と要求される機能を比較するために使用されます。
	Equals	オーバーロードされます。 オーバーライドされます。 指定した DataSourceSelectArguments オブジェクトが現在のオブジェクトと等しいかどうかを判断します。
	GetHashCode	オーバーライドされます。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	RaiseUnsupportedCapabilitiesError	ExecuteSelect 操作に対して要求される機能と、指定したデータ ソース ビューでサポートされている機能を比較します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

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

参照

関連項目

DataSourceSelectArguments クラス
System.Web.UI 名前空間
DataSourceCapabilities 列挙体

DataSourceSelectArguments メンバ

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

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

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

	名前	説明
	DataSourceSelectArguments	オーバーロードされます。 DataSourceSelectArguments クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	MaximumRows	データ取得操作でデータ ソース コントロールから返されるデータ行の最大数を表す値を取得または設定します。
	RetrieveTotalRowCount	データ ソース コントロールで、データ取得操作の実行中にデータ行の合計数を取得する必要があるかどうかを示す値を取得または設定します。
	SortExpression	DataSourceView.Select メソッドにより取得されたデータを並べ替えるためにデータ ソース ビューで使用する式を取得または設定します。
	StartRowIndex	データ取得操作中にデータ行を取得するときにデータ ソース コントロールで使用する開始位置を表す値を取得または設定します。
	TotalRowCount	データ取得操作で取得される行の数を取得または設定します。

パブリック メソッド

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

	名前	説明
	AddSupportedCapabilities	DataSourceSelectArguments インスタンスに機能を 1 つ追加します。この機能は、サポートされている機能と要求される機能を比較するために使用されます。
	Equals	オーバーロードされます。 オーバーライドされます。 指定した DataSourceSelectArguments オブジェクトが現在のオブジェクトと等しいかどうかを判断します。
	GetHashCode	オーバーライドされます。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	RaiseUnsupportedCapabilitiesError	ExecuteSelect 操作に対して要求される機能と、指定したデータ ソース ビューでサポートされている機能を比較します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

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

参照

関連項目

DataSourceSelectArguments クラス
System.Web.UI 名前空間
DataSourceCapabilities 列挙体