DataPager.PageSize Property (System.Web.UI.WebControls)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
DataPager.PageSize Property

Gets or sets the number of records that are displayed for each page of data.

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)
Syntax
Visual Basic
Public Property PageSize As Integer
C#
public int PageSize { get; set; }
Visual C++
public:
property int PageSize {
	int get ();
	void set (int value);
}
F#
member PageSize : int with get, set
ASP.NET
<asp:DataPager PageSize="Int32" />

Property Value

Type: System.Int32
The number of records that are displayed for each page of data. The default is 10.
Exceptions
Exception Condition
ArgumentOutOfRangeException

The PageSize property is set to a value less than 1.
Remarks

Use the PageSize property to specify the size of a page of data.

If you have multiple DataPager controls in a page that are bound to the same ListView control, be sure to set the PageSize property of these controls to the same value. If the DataPager controls are set to use different page sizes, the last DataPager control to be initialized determines the actual page size of the ListView control.

Examples

The following example shows how to declaratively set the PageSize property in a DataPager control and how to dynamically change its value.

Visual Basic

<%@ Page language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  Protected Sub ResultsList_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs) 

    ' Set the page size with the value
    ' selected in the DropDownList object  
    VendorsDataPager.PageSize = Convert.ToInt32(ResultsList.SelectedValue)

  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head id="Head1" runat="server">
    <title>DataPager PageSize Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>DataPager PageSize Example</h3>

      <table border="0" width="640px">
        <tr>
          <td align="left">
            <asp:Label id="ResultsLabel" runat="server" 
              AssociatedControlID="ResultsList" Text="Results per page:" />            
            <asp:DropDownList runat="server" id="ResultsList" 
              OnSelectedIndexChanged="ResultsList_SelectedIndexChanged" AutoPostBack="true">              
              <asp:ListItem Value="10"  />
              <asp:ListItem Value="15" Selected="True" />
              <asp:ListItem Value="20" />
            </asp:DropDownList>
          </td>
          <td align="right">
            <asp:DataPager ID="VendorsDataPager" runat="server" 
              PagedControlID="VendorsListView" PageSize="15">
              <Fields>
                <asp:NumericPagerField />
              </Fields>
            </asp:DataPager>          
          </td>
        </tr>
      </table>
      <br />

      <asp:ListView ID="VendorsListView" 
        DataSourceID="VendorsDataSource"
        runat="server">
        <LayoutTemplate>
          <table cellpadding="2" width="640px">
              <tr runat="server" id="itemPlaceholder"></tr>
          </table>
        </LayoutTemplate>
        <ItemTemplate>
          <tr runat="server">
            <td>
              <asp:Label ID="VendorIDLabel" runat="server" Text='<%# Eval("VendorID") %>' />
            </td>
            <td>
              <asp:Label ID="AccountNumberLabel" runat="server" Text='<%# Eval("AccountNumber") %>' />
            </td>
            <td>
              <asp:Label ID="NameLabel" runat="server" Text='<%# Eval("Name") %>' />
            </td>
            <td align="center">
              <asp:CheckBox ID="PreferredCheckBox" runat="server" 
                Checked='<%# Eval("PreferredVendorStatus") %>' Enabled="False" />
            </td>
          </tr>
        </ItemTemplate>
      </asp:ListView>

      <!-- This example uses Microsoft SQL Server and connects      -->
      <!-- to the AdventureWorks sample database. Use an ASP.NET    -->
      <!-- expression to retrieve the connection string value       -->
      <!-- from the Web.config file.                                -->
      <asp:SqlDataSource ID="VendorsDataSource" runat="server" 
        ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"            
        SelectCommand="SELECT VendorID, AccountNumber, Name, PreferredVendorStatus 
          FROM Purchasing.Vendor WHERE (ActiveFlag = 1)" >
      </asp:SqlDataSource>
    </form>
  </body>
</html>
C#

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  protected void ResultsList_SelectedIndexChanged(object sender, EventArgs e)
  {
    // Set the page size with the value
    // selected in the DropDownList object
    VendorsDataPager.PageSize = Convert.ToInt32(ResultsList.SelectedValue);
  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head id="Head1" runat="server">
    <title>DataPager PageSize Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>DataPager PageSize Example</h3>

      <table border="0" width="640px">
        <tr>
          <td align="left">
            <asp:Label id="ResultsLabel" runat="server" 
              AssociatedControlID="ResultsList" Text="Results per page:" />            
            <asp:DropDownList runat="server" id="ResultsList" 
              OnSelectedIndexChanged="ResultsList_SelectedIndexChanged" AutoPostBack="true">              
              <asp:ListItem Value="10"  />
              <asp:ListItem Value="15" Selected="True" />
              <asp:ListItem Value="20" />
            </asp:DropDownList>
          </td>
          <td align="right">
            <asp:DataPager ID="VendorsDataPager" runat="server" 
              PagedControlID="VendorsListView" PageSize="15">
              <Fields>
                <asp:NumericPagerField />
              </Fields>
            </asp:DataPager>          
          </td>
        </tr>
      </table>
      <br />

      <asp:ListView ID="VendorsListView" 
        DataSourceID="VendorsDataSource"
        runat="server">
        <LayoutTemplate>
          <table cellpadding="2" width="640px">
              <tr runat="server" id="itemPlaceholder"></tr>
          </table>
        </LayoutTemplate>
        <ItemTemplate>
          <tr runat="server">
            <td>
              <asp:Label ID="VendorIDLabel" runat="server" Text='<%# Eval("VendorID") %>' />
            </td>
            <td>
              <asp:Label ID="AccountNumberLabel" runat="server" Text='<%# Eval("AccountNumber") %>' />
            </td>
            <td>
              <asp:Label ID="NameLabel" runat="server" Text='<%# Eval("Name") %>' />
            </td>
            <td align="center">
              <asp:CheckBox ID="PreferredCheckBox" runat="server" 
                Checked='<%# Eval("PreferredVendorStatus") %>' Enabled="False" />
            </td>
          </tr>
        </ItemTemplate>
      </asp:ListView>

      <!-- This example uses Microsoft SQL Server and connects      -->
      <!-- to the AdventureWorks sample database. Use an ASP.NET    -->
      <!-- expression to retrieve the connection string value       -->
      <!-- from the Web.config file.                                -->
      <asp:SqlDataSource ID="VendorsDataSource" runat="server" 
        ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"            
        SelectCommand="SELECT VendorID, AccountNumber, Name, PreferredVendorStatus 
          FROM Purchasing.Vendor WHERE (ActiveFlag = 1)" >
      </asp:SqlDataSource>
    </form>
  </body>
</html>
Version Information

.NET Framework

Supported in: 4, 3.5
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also

Reference

DataPager Class
System.Web.UI.WebControls Namespace
ListView

Other Resources

ListView Web Server Control Overview