GridView.PagerSettings Property (System.Web.UI.WebControls)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
GridView.PagerSettings Property

Note: This property is new in the .NET Framework version 2.0.

Gets a reference to the PagerSettings object that allows you to set the properties of the pager buttons in a GridView control.

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

Syntax
Visual Basic (Declaration)
Public Overridable ReadOnly Property PagerSettings As PagerSettings
Visual Basic (Usage)
Dim instance As GridView
Dim value As PagerSettings

value = instance.PagerSettings
C#
public virtual PagerSettings PagerSettings { get; }
C++
public:
virtual property PagerSettings^ PagerSettings {
	PagerSettings^ get ();
}
J#
/** @property */
public PagerSettings get_PagerSettings ()
JScript
public function get PagerSettings () : PagerSettings

Property Value

A reference to the PagerSettings that allows you to set the properties of the pager buttons in a GridView control.
Remarks

Use the PagerSettings property to control the settings of the pager row in a GridView control. The pager row is displayed when the paging feature is enabled (by setting the AllowPaging property to true) and contains the controls that allow the user to navigate to the different pages in the control. This property is read-only; however, you can set the properties of the PagerSettings object it returns. The properties can be set declaratively using one of the following methods:

  • Place an attribute in the opening tag of the GridView control in the form Property-Subproperty, where Subproperty is a property of the PagerSettings object (for example, PagerSettings-Mode).

  • Nest a <PagerSettings> element between the opening and closing tags of the GridView control.

The properties can also be set programmatically in the form Property.Subproperty (for example, PagerStyle.Mode). Common settings usually include the pager row's display mode and custom text or images for the navigation controls.

Example

The following code example demonstrates how to set the PagerSettings property declaratively. It sets the font and background for the pager row to blue and light blue, respectively.

Visual Basic

<%@ Page language="VB" %>

<html>
  <body>
    <form 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>
C#

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

<html>
  <body>
    <form 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>
Platforms

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

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

Version Information

.NET Framework

Supported in: 2.0
See Also