Export (0) Print
Expand All
Expand Minimize

GridView.AllowPaging Property

Gets or sets a value indicating whether the paging feature is enabled.

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

abstract AllowPaging : bool with get, set 
override AllowPaging : bool with get, set
<asp:GridView AllowPaging="True|False" />

Property Value

Type: System.Boolean
true if the paging feature is enabled; otherwise, false. The default is false.

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. If the data source supports the paging capability, the GridView control can take advantage of that and provide built-in paging functionality. 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.

To enable the paging feature, set the AllowPaging property to true. By default, the GridView control displays 10 records on a page at a time. You can change the number of records displayed on a page by setting the PageSize property. To determine the total number of pages required to display the data source contents, use the PageCount property. You can determine the index of the currently displayed page by using the PageIndex property.

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. 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. The pager row can be displayed at the top, bottom, or both the top and bottom of the control by setting the Position property. 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.

To control the appearance of the pager row (including its background color, font color, and position), use the PagerStyle property.

NoteNote

The GridView control automatically hides the pager row when the data source contains only one page of records.

The GridView control also enables you to define a custom template for the pager row. For more information about creating a custom pager row template, see PagerTemplate.

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.

Event

Description

PageIndexChanged

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

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.

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

The following example demonstrates how to use the AllowPaging property to declaratively enable the paging feature in the GridView control.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft