DataSourceSelectArguments.RetrieveTotalRowCount プロパティ

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

DataSourceSelectArguments.RetrieveTotalRowCount プロパティ

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

データ ソース コントロールで、データ取得操作の実行中にデータ行の合計数を取得する必要があるかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Property RetrieveTotalRowCount As
 Boolean

Visual Basic (使用法)

Dim instance As DataSourceSelectArguments
Dim value As Boolean

value = instance.RetrieveTotalRowCount

instance.RetrieveTotalRowCount = value

C#

public bool RetrieveTotalRowCount { get;
 set; }

C++

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

J#

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

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

JScript

public function get RetrieveTotalRowCount
 () : boolean

public function set RetrieveTotalRowCount
 (value : boolean)

プロパティ値
データ ソース コントロールでデータ行の合計数を取得する必要がある場合は true。それ以外の場合は false。

解説

RetrieveTotalRowCount プロパティは、ページングをサポートします。データ取得操作の実行中に、データ ソース コントロールに行の合計数を要求するには、このプロパティを true に設定します。データ ソース ビューで、行の合計数を取得する操作がサポートされているかどうかを確認するには、DataSourceView.CanRetrieveTotalRowCount プロパティをチェックします。データ ソースでこの操作がサポートされている場合、データ取得操作の実行中に、データ ソース コントロールによって TotalRowCount プロパティが設定されます。値はメソッドの出力パラメータに返されますが、データ行の合計数は TotalRowCount プロパティに返されます。

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

プラットフォーム

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 名前空間
CanRetrieveTotalRowCount
TotalRowCount