GridView.AllowPaging プロパティ

定義

ページング機能が有効かどうかを示す値を取得または設定します。Gets or sets a value indicating whether the paging feature is enabled.

public:
 virtual property bool AllowPaging { bool get(); void set(bool value); };
public virtual bool AllowPaging { get; set; }
member this.AllowPaging : bool with get, set
Public Overridable Property AllowPaging As Boolean

プロパティ値

ページング機能が有効な場合は true。それ以外の場合は falsetrue if the paging feature is enabled; otherwise, false. 既定値は、false です。The default is false.

次の例は、 AllowPagingプロパティを使用して、 GridViewコントロールのページング機能を宣言によって有効にする方法を示しています。The following example demonstrates how to use the AllowPaging property to declaratively enable the paging feature in the GridView control.


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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>GridView AllowPaging Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>GridView AllowPaging Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true" 
        runat="server">
                
        <pagersettings mode="Numeric"
          position="Bottom"           
          pagebuttoncount="10"/>
                      
        <pagerstyle backcolor="LightBlue"
          height="30px"
          verticalalign="Bottom"
          horizontalalign="Center"/>
                
      </asp:gridview>
            
      <!-- 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="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
        runat="server"/>
        
    </form>
  </body>
</html>


<%@ Page language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>GridView AllowPaging Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>GridView AllowPaging Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true" 
        runat="server">
                
        <pagersettings mode="Numeric"
          position="Bottom"           
          pagebuttoncount="10"/>
                      
        <pagerstyle backcolor="LightBlue"
          height="30px"
          verticalalign="Bottom"
          horizontalalign="Center"/>
                
      </asp:gridview>
            
      <!-- 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="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
        runat="server"/>
        
    </form>
  </body>
</html>

注釈

GridViewコントロールでは、データソース内のすべてのレコードを同時に表示するのではなく、自動的にページにレコードを分割できます。Instead of displaying all the records in the data source at the same time, the GridView control can automatically break the records up into pages. データソースがページング機能をサポートしているGridView場合、コントロールはその機能を利用し、組み込みのページング機能を提供できます。If the data source supports the paging capability, the GridView control can take advantage of that and provide built-in paging functionality. ページング機能は、インターフェイスをSystem.Collections.ICollectionサポートする任意のデータソースオブジェクト、またはページング機能をサポートするデータソースで使用できます。The paging feature can be used with any data source object that supports the System.Collections.ICollection interface or a data source that supports paging capability.

ページング機能を有効にするにはAllowPaging 、プロパティtrueをに設定します。To enable the paging feature, set the AllowPaging property to true. 既定では、 GridViewコントロールは、一度に1ページに10個のレコードを表示します。By default, the GridView control displays 10 records on a page at a time. ページに表示されるレコードの数を変更するには、 PageSizeプロパティを設定します。You can change the number of records displayed on a page by setting the PageSize property. データソースの内容を表示するために必要なページの合計数を確認PageCountするには、プロパティを使用します。To determine the total number of pages required to display the data source contents, use the PageCount property. 現在表示されているページのインデックスを確認するにPageIndexは、プロパティを使用します。You can determine the index of the currently displayed page by using the PageIndex property.

ページングを有効にすると、ページャー行と呼ばれる追加の行がGridViewコントロールに自動的に表示されます。When paging is enabled, an additional row called the pager row is automatically displayed in the GridView control. ページャー行には、ユーザーが他のページに移動できるようにするコントロールが含まれています。The pager row contains controls that allow the user to navigate to the other pages. PagerSettingsプロパティを使用して、ページャーの表示モード、一度に表示するページリンクの数、およびページャーコントロールのテキストラベルなど、ページャーの行の設定を制御できます。You can control the settings of the pager row (such as the pager display mode, the number of page links to display at a time, and the pager control's text labels) by using the PagerSettings property. ページャー行は、プロパティをPosition設定することによって、コントロールの上部、下部、またはその両方に表示できます。The pager row can be displayed at the top, bottom, or both the top and bottom of the control by setting the Position property. また、プロパティを設定して、 Mode 4 つの組み込みのページャー表示モードのいずれかを選択することもできます。You can also select from one of four built-in pager display modes by setting the Mode property. 次の表では、組み込みの表示モードについて説明します。The following table describes the built-in display modes.

モードMode 説明Description
PagerButton.NextPrevious [戻る] ボタンと [次へ] ボタンで構成される改ページコントロールのセット。A set of pagination controls consisting of previous and next buttons.
PagerButton.NextPreviousFirstLast [戻る]、[次へ]、[最初へ]、[最後] の各ボタンで構成される改ページコントロールのセット。A set of pagination controls consisting of previous, next, first, and last buttons.
PagerButton.Numeric 直接ページにアクセスする番号付きリンク ボタンで構成されるページ編集コントロールのセット。A set of pagination controls consisting of numbered link buttons to access pages directly. これは既定のモードです。This is the default mode.
PagerButton.NumericFirstLast 番号付きおよび最初と最後のリンクボタンで構成される改ページコントロールのセット。A set of pagination controls consisting of numbered and first and last link buttons.

ページャー行の外観 (背景色、フォントの色、位置など) を制御するには、 PagerStyleプロパティを使用します。To control the appearance of the pager row (including its background color, font color, and position), use the PagerStyle property.

注意

データGridViewソースにレコードのページが1つしか含まれていない場合、コントロールは自動的にページャーの行を非表示にします。The GridView control automatically hides the pager row when the data source contains only one page of records.

コントロールGridViewでは、ページャー行のカスタムテンプレートを定義することもできます。The GridView control also enables you to define a custom template for the pager row. カスタムのページャー行テンプレートの作成の詳細についてPagerTemplateは、「」を参照してください。For more information about creating a custom pager row template, see PagerTemplate.

コントロールGridViewには、ページングが発生したときにカスタムアクションを実行するために使用できるいくつかのイベントが用意されています。The GridView control provides several events that you can use to perform a custom action when paging occurs. 次の表に、使用可能なイベントを示します。The following table lists the available events.

eventEvent 説明Description
PageIndexChanged ページャー ボタンの 1 つがクリックされた場合に、GridView コントロールがページング操作を処理した後に発生します。Occurs when one of the pager buttons is clicked, but after the GridView control handles the paging operation. このイベントは、ユーザーがコントロール内の別のページに移動した後にタスクを実行する必要がある場合によく使用されます。This event is commonly used when you need to perform a task after the user navigates to a different page in the control.
PageIndexChanging ページャー ボタンの 1 つがクリックされた場合に、GridView コントロールがページング操作を処理する前に発生します。Occurs when one of the pager buttons is clicked, but before the GridView control handles the paging operation. このイベントは、ページング操作をキャンセルするためによく使用されます。This event is often used to cancel the paging operation.

適用対象

こちらもご覧ください