DetailsView.AllowPaging プロパティ

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

DetailsView.AllowPaging プロパティ

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

ページング機能を有効にするかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Overridable Property
 AllowPaging As Boolean

Visual Basic (使用法)

Dim instance As DetailsView
Dim value As Boolean

value = instance.AllowPaging

instance.AllowPaging = value

C#

public virtual bool AllowPaging { get;
 set; }

C++

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

J#

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

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

JScript

public function get AllowPaging
 () : boolean

public function set AllowPaging
 (value : boolean)

プロパティ値
ページング機能を有効にする場合は true。それ以外の場合は false。既定値は false です。

解説

DetailsView コントロールには、ユーザーがデータ ソース内の別のレコードに移動できるページング機能があります。

DetailsView コントロールは、ユーザー インターフェイス (UI) およびデータ ソースの両方のページングを実行できます。UI ページング機能は、System.Collections.ICollection インターフェイスをサポートするすべてのデータ ソース オブジェクトで使用できます。ページング操作ごとに、DetailsView コントロールはデータ コレクション全体のデータ ソースを照会し、表示する行を選択します。基本的に、残りのデータは破棄されます。

データ ソースで DataSourceView を実装している場合に CanPage プロパティから true が返されると、DetailsView コントロールは UI ページングの代わりにデータ ソース ページングを使用します。この場合、DetailsView コントロールは各ページング操作に必要な行だけを照会します。このため、データ ソース ページングは UI ページングよりも効率的です。変更を加えずにデータ ソース ページングをサポートできるのは ObjectDataSourceView オブジェクトだけです。

ページング機能を有効にするには、AllowPaging プロパティを true に設定します。PageCount プロパティを使用すると、基になるデータ ソースの合計項目数を確認できます。現在表示されている項目のインデックスを確認するには、PageIndex プロパティを使用します。

ページングが有効になっている場合、ページ行と呼ばれる追加行が自動的に DetailsView コントロールに表示されます。ページ行にはページ ナビゲーション コントロールが含まれ、コントロールの上部、下部、または上部と下部の両方に表示できます。ページ行には、組み込みのページャ表示モードが 2 つあります。1 つは番号付きページにリンクするモードで、もう 1 つは次のページおよび前のページにリンクするモード (既定) です。番号付きページ モードでは個々のページへのリンクが表示されるため、ユーザーは特定のページに移動できます。次のページおよび前のページへのリンク モードでは、ユーザーが次のページまたは前のページに移動できるコントロールが表示されます。

メモ
データ ソースに格納されているレコードがない、または 1 つのレコードしか格納されていない場合、DetailsView コントロールは、自動的にページ行を非表示にします。

ページ行の設定 (ページャ表示モード、一度に表示するページ リンクの数、ページャ コントロールのテキスト ラベルなど) は、PagerSettings プロパティを使用して制御できます。ページ行の外観 (背景色、フォントの色、位置など) を制御するには、PagerStyle プロパティを使用します。DetailsView コントロールでは、ページ行用のカスタム テンプレートも定義できます。カスタム ページ行テンプレートの作成の詳細については、PagerTemplate のトピックを参照してください。

DetailsView コントロールには、ページングが発生したときにカスタム アクションを実行するために使用できる複数のイベントが用意されています。使用できるイベントの一覧を次の表に示します。

イベント	説明
PageIndexChanged	ページャ ボタンの 1 つがクリックされた場合に、DetailsView コントロールがページング操作を処理した後に発生します。このイベントは通常、ユーザーがコントロール内の別のレコードに移動した後にタスクを実行する必要がある場合に使用されます。
PageIndexChanging	ページャ ボタンの 1 つがクリックされた場合に、DetailsView コントロールがページング操作を処理する前に発生します。このイベントは、ページング操作をキャンセルする場合などに使用されます。

AllowPaging の値はビューステートに格納されます。

使用例

AllowPaging プロパティを使用して、DetailsView コントロールのページング機能を有効にする方法のコード例を次に示します。

Visual Basic

<%@ Page language="VB" %>

<html>
  <body>
    <form id="Form1" runat="server">
        
      <h3>DetailsView AllowPaging Example</h3>
                
        <asp:detailsview id="StoresDetailView"
          datasourceid="Customers"
          autogeneraterows="true" 
          allowpaging="true"
          runat="server">
               
          <headerstyle backcolor="Navy"
            forecolor="White"/>
            
          <pagersettings mode="NextPreviousFirstLast"
            firstpagetext="First"
            lastpagetext="Last"
            nextpagetext="Next"
            previouspagetext="Prev"/>
            
          <pagerstyle forecolor="White"
            backcolor="Blue"
            font-names="Arial"
            font-size="8" />   
        </asp:detailsview>
            
        <!-- This example uses Microsoft SQL Server and connects
 -->
        <!-- to the Northwind sample database. -->     
      
        <asp:SqlDataSource ID="Customers" runat="server"
 
          ConnectionString=
            "<%$ ConnectionStrings:NorthwindConnectionString
 %>"
          SelectCommand="SELECT [CompanyName], [ContactName], 
             [CustomerID] FROM [Customers]">
        </asp:SqlDataSource>
            
      </form>
  </body>
</html>

C#

<%@ Page language="C#" %>

<html>
  <body>
    <form id="Form1" runat="server">
        
      <h3>DetailsView AllowPaging Example</h3>
                
        <asp:detailsview id="StoresDetailView"
          datasourceid="Customers"
          autogeneraterows="true" 
          allowpaging="true"
          runat="server">
               
          <headerstyle backcolor="Navy"
            forecolor="White"/>
            
          <pagersettings mode="NextPreviousFirstLast"
            firstpagetext="First"
            lastpagetext="Last"
            nextpagetext="Next"
            previouspagetext="Prev"/>
            
          <pagerstyle forecolor="White"
            backcolor="Blue"
            font-names="Arial"
            font-size="8" />   
        </asp:detailsview>
            
        <!-- This example uses Microsoft SQL Server and connects -->
        <!-- to the Northwind sample database. -->           
        <asp:SqlDataSource ID="Customers" runat="server" 
          ConnectionString=
            "<%$ ConnectionStrings:NorthwindConnectionString %>"
          SelectCommand="SELECT [CompanyName], [ContactName], 
             [CustomerID] FROM [Customers]">
        </asp:SqlDataSource>
            
      </form>
  </body>
</html>

プラットフォーム

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

参照

関連項目
DetailsView クラス
DetailsView メンバ
System.Web.UI.WebControls 名前空間
BottomPagerRow
PageCount
PageIndex
PagerSettings
PagerStyle
TopPagerRow
PageIndexChanged
PageIndexChanging