FormView.AllowPaging プロパティ

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

FormView.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 FormView
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 です。

解説

FormView コントロールには、ユーザーがデータ ソース内の別のレコードに移動できるページング機能があります。ページング機能は、System.Collections.ICollection インターフェイスをサポートするデータ ソース オブジェクト、またはページング機能をサポートするデータ ソースで使用できます。

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

ページングが有効になっている場合、ページ行と呼ばれる追加行が自動的に FormView コントロールに表示されます。ページ行にはページ ナビゲーション コントロールが含まれ、コントロールの上部、下部、または上部と下部の両方に表示できます。ページ行には、4 つの組み込みのページャ表示モードがあります。この 4 つのモードを次の表に示します。

モード	説明
PagerButton.NextPrevious	戻るボタンと次へボタンで構成されるページ編集コントロールのセット。
PagerButton.NextPreviousFirstLast	戻る、次へ、先頭、末尾の各ボタンで構成されるページ編集コントロールのセット。
PagerButton.Numeric	直接ページにアクセスする番号付きリンク ボタンで構成されるページ編集コントロールのセット。これは、既定のモードです。
PagerButton.NumericFirstLast	番号付き、先頭と末尾の各リンク ボタンで構成されるページ編集コントロールのセット。

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

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

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

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

メモ
これらのイベントは、プログラムによって PageIndex プロパティを変更した場合には発生しません。

使用例

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

Visual Basic

<%@ Page language="VB" %>

<html>
  <body>
    <form runat="server">
        
      <h3>FormView AllowPaging Example</h3>
                       
      <asp:formview id="EmployeeFormView"
        datasourceid="EmployeeSource"
        allowpaging="true"
        datakeynames="EmployeeID" 
        runat="server">
        
        <pagersettings mode="Numeric"
          position="Bottom"/>
          
        <pagerstyle backcolor="LightBlue"
          horizontalalign="Center"/>
        
        <itemtemplate>
        
          <table>
            <tr>
              <td>
                <asp:image id="EmployeeImage"
                  imageurl='<%# Eval("PhotoPath") %>'
                  alternatetext='<%# Eval("LastName") %>'
 
                  runat="server"/>
              </td>
              <td>
                <h3><%# Eval("FirstName")
 %>&nbsp;<%# Eval("LastName") %></h3>
      
                <%# Eval("Title") %>       
 
              </td>
            </tr>
          </table>
        
        </itemtemplate> 
                  
      </asp:formview>
          
      <!-- This example uses Microsoft SQL Server and connects
  -->
      <!-- to the Northwind sample database. Use an ASP.NET
     -->
      <!-- expression to retrieve the connection string
 value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="EmployeeSource"
        selectcommand="Select [EmployeeID], [LastName], [FirstName],
 [Title], [PhotoPath] From [Employees]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
        runat="server"/>
            
    </form>
  </body>
</html>

C#

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

<html>
  <body>
    <form runat="server">
        
      <h3>FormView AllowPaging Example</h3>
                       
      <asp:formview id="EmployeeFormView"
        datasourceid="EmployeeSource"
        allowpaging="true"
        datakeynames="EmployeeID" 
        runat="server">
        
        <pagersettings mode="Numeric"
          position="Bottom"/>
          
        <pagerstyle backcolor="LightBlue"
          horizontalalign="Center"/>
        
        <itemtemplate>
        
          <table>
            <tr>
              <td>
                <asp:image id="EmployeeImage"
                  imageurl='<%# Eval("PhotoPath") %>'
                  alternatetext='<%# Eval("LastName") %>' 
                  runat="server"/>
              </td>
              <td>
                <h3><%# Eval("FirstName") %>&nbsp;<%#
 Eval("LastName") %></h3>      
                <%# Eval("Title") %>        
              </td>
            </tr>
          </table>
        
        </itemtemplate> 
                  
      </asp:formview>
          
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value
   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="EmployeeSource"
        selectcommand="Select [EmployeeID], [LastName], [FirstName], [Title],
 [PhotoPath] From [Employees]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
        runat="server"/>
            
    </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

参照

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