PagerSettings Class
Assembly: System.Web (in system.web.dll)
[TypeConverterAttribute(typeof(ExpandableObjectConverter))] public ref class PagerSettings sealed : IStateManager
/** @attribute TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter) */ public final class PagerSettings implements IStateManager
TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter) public final class PagerSettings implements IStateManager
Not applicable.
Controls that support pagination (such as the GridView, DetailsView, and FormView controls) can display a set of controls called the pager that allows the user to navigate the pages within the control. The PagerSettings class is used by these controls to represent the properties of the pager. In general, the PagerSettings object is stored in the PagerSettings property of the control. You can customize the pager by setting the properties of the PagerSettings object.
The pager supports several different display modes. To specify the mode in which to display the pager, set the Mode property. The following table describes the different modes.
| Mode | Description |
|---|---|
| Previous-page and next-page buttons. | |
| Previous-page, next-page, first-page, and last -page buttons. | |
| Numbered link buttons to access pages directly. | |
| Numbered-link, first-link, and last-link buttons. |
When the Mode property is set to the NextPrevious, NextPreviousFirstLast, or NumericFirstLast value you can customize the text of the non-numeric buttons by setting the properties shown in the following table.
| Property | Description |
|---|---|
| Text for the first-page button. | |
| Text for the previous-page button. | |
| Text for the next-page button. | |
| Text for the last-page button. |
As an alternative, you can also display images for the non-numeric buttons by setting the properties as shown in the following table.
| Property | Description |
|---|---|
| The URL to an image to display for the first-page button. | |
| The URL to an image to display for the previous-page button. | |
| The URL to an image to display for the next-page button. | |
| The URL to an image to display for the last-page button. |
Note: |
|---|
| When an image property is set, the corresponding text property acts as the alternate text for the image. For example, when the FirstPageImageUrl property is set, the text that is specified by the FirstPageText property is displayed as the alternate text for the image. On browsers that support ToolTips, this text is also displayed as a ToolTip for the corresponding button. |
When the Mode property is set to the Numeric or NumericFirstLast value, you can specify the number of page buttons to display in the pager by setting the PageButtonCount property.
The pager can be displayed at the top, the bottom, or both the top and bottom of a control. To specify the position of the pager, set the Position property. To show or hide the pager, use the Visible property.
The following code example demonstrates how to use the PagerSettings object that is contained in the PagerSettings property to customize the text of the buttons that are displayed in the pager row of a GridView control.
- AspNetHostingPermission for operating in a hosted environment. Demand value: LinkDemand; Permission value: Minimal.
Reference
PagerSettings MembersSystem.Web.UI.WebControls Namespace
DetailsView
DetailsView.AllowPaging Property
DetailsView.PagerSettings Property
FormView
FormView.AllowPaging Property
FormView.PagerSettings Property
GridView
GridView.AllowPaging Property
GridView.PagerSettings Property
Mode
FirstPageText
FirstPageImageUrl
PreviousPageText
PreviousPageImageUrl
NextPageText
LastPageText
LastPageImageUrl
PageButtonCount
Position
Visible
Note: