ObjectDataSourceView.EnablePaging プロパティ

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

ObjectDataSourceView.EnablePaging プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

データ ソース コントロールが、取得した一連のデータ全体にわたるページングをサポートするかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Property EnablePaging As
 Boolean

Visual Basic (使用法)

Dim instance As ObjectDataSourceView
Dim value As Boolean

value = instance.EnablePaging

instance.EnablePaging = value

C#

public bool EnablePaging { get;
 set; }

C++

public:
property bool EnablePaging {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_EnablePaging ()

/** @property */
public void set_EnablePaging (boolean value)

JScript

public function get EnablePaging
 () : boolean

public function set EnablePaging
 (value : boolean)

プロパティ値
データ ソース コントロールが取得したデータを使用するページングをサポートする場合はtrue。それ以外の場合は false。

解説

ObjectDataSourceView コントロールによるページングは、ObjectDataSourceView の EnablePaging、StartRowIndexParameterName、MaximumRowsParameterName、SelectCountMethod の各プロパティを設定し、適切なパラメータを使用してビジネス オブジェクト内に Select メソッドを定義することにより処理されます。EnablePaging プロパティを true に設定すると、SelectParameters コレクションに、要求された最初の行と要求された行数に対応する 2 つの追加パラメータが格納されます。これら 2 つのパラメータには、StartRowIndexParameterName プロパティおよび MaximumRowsParameterName プロパティで定義した名前が付けられます。Select メソッドは、指定したインデックス位置から始まる要求された行数を返す必要があります。データはページ サイズごとに均等に分割されるとは限らないため、最後のページの行数が少なくなる可能性があります。このため、要求された行数は、実際には返される最大数となります。

ExecuteSelect メソッドへの呼び出し中に CanRetrieveTotalRowCount プロパティがチェックされ、各種の DataSourceSelectArguments プロパティを設定して要求されたすべての機能が、データ ソース コントロールで確実にサポートされるようにします。

関連するデータ バインド コントロール上でページングが有効になっている場合、データ バインド コントロールは、必須である開始インデックスと行数を使用して Select メソッドを呼び出します。さらに、SelectCountMethod プロパティが設定されている場合、データ バインド コントロールは、ページャ コントロールを表示する前にメソッドを呼び出します。たとえば、GridView コントロールのページングがページ サイズ 5 で有効になっていて、SelectCountMethod メソッドから 20 が返された場合、ページャには 4 ページしか表示されません。

EnablePaging プロパティの値はビューステートに格納されます。

プラットフォーム

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

参照

関連項目
ObjectDataSourceView クラス
ObjectDataSourceView メンバ
System.Web.UI.WebControls 名前空間
StartRowIndexParameterName
MaximumRowsParameterName
ObjectDataSourceView.CanPage プロパティ