.NET Framework Class Library
GridView..::.PageSize Property

Gets or sets the number of records to display on a page in a GridView control.

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
Syntax

Visual Basic (Declaration)
Public Overridable Property PageSize As Integer
Visual Basic (Usage)
Dim instance As GridView
Dim value As Integer

value = instance.PageSize

instance.PageSize = value
C#
public virtual int PageSize { get; set; }
Visual C++
public:
virtual property int PageSize {
    int get ();
    void set (int value);
}
JScript
public function get PageSize () : int
public function set PageSize (value : int)
ASP.NET
<asp:GridView PageSize="Int32" />

Property Value

Type: System..::.Int32
The number of records to display on a single page. The default is 10.
Exceptions

ExceptionCondition
ArgumentOutOfRangeException

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

Remarks

When the paging feature is enabled (by setting the AllowPaging property to true), use the PageSize property to specify the number of records to display on a single page.

TopicLocation
How to: Enable Default Paging in the GridView Web Server ControlBuilding ASP .NET Web Applications in Visual Studio
How to: Enable Default Paging in the GridView Web Server ControlBuilding ASP .NET Web Applications in Visual Studio
How to: Enable Default Paging in the GridView Web Server ControlBuilding ASP .NET Web Applications in Visual Studio
Examples

The following example demonstrates how to use the PageSize property to display 15 records at a time in a GridView control.

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">
<html  >
  <head runat="server">
    <title>GridView PageSize Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>GridView PageSize Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true" 
        pagesize="15"
        runat="server">

      </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>

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

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

      <h3>GridView PageSize Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true" 
        pagesize="15"
        runat="server">

      </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>

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Tags :


Community Content

CSharpUniversity.com
Tutorial for how to use PageSize to customize a GridView control

To see a tutorial with examples and video showing how to use the PageSize property in a GridView with a SqlDataSource go to: http://www.csharpuniversity.com/2008/12/31/paging-data-with-the-aspnet-sqldatasource-and-gridview-controls/

Enter your e-mail address there and receive notification every time a new article is posted.

Tags :

Page view tracker