PagerSettings Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents the properties of the paging controls in a control that supports pagination. This class cannot be inherited.
public ref class PagerSettings sealed : System::Web::UI::IStateManager[System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))]
public sealed class PagerSettings : System.Web.UI.IStateManager[<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))>]
type PagerSettings = class
interface IStateManagerPublic NotInheritable Class PagerSettings
Implements IStateManager- Inheritance
-
PagerSettings
- Attributes
- Implements
Examples
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.
<%@ Page language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>PagerSetting Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>PagerSetting Example</h3>
<asp:gridview id="CustomerGridView"
datasourceid="CustomerDataSource"
autogeneratecolumns="true"
datakeynames="CustomerID"
allowpaging="true"
runat="server">
<pagersettings mode="NextPreviousFirstLast"
firstpagetext="First"
lastpagetext="Last"
nextpagetext="Next"
previouspagetext="Prev"
position="Bottom"/>
</asp:gridview>
<br/>
<asp:label id="MessageLabel"
forecolor="Red"
runat="server"/>
<!-- 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="CustomerDataSource"
selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
runat="server"/>
</form>
</body>
</html>
<%@ Page language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>PagerSetting Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>PagerSetting Example</h3>
<asp:gridview id="CustomerGridView"
datasourceid="CustomerDataSource"
autogeneratecolumns="true"
datakeynames="CustomerID"
allowpaging="true"
runat="server">
<pagersettings mode="NextPreviousFirstLast"
firstpagetext="First"
lastpagetext="Last"
nextpagetext="Next"
previouspagetext="Prev"
position="Bottom"/>
</asp:gridview>
<br/>
<asp:label id="MessageLabel"
forecolor="Red"
runat="server"/>
<!-- 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="CustomerDataSource"
selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
runat="server"/>
</form>
</body>
</html>
Remarks
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 |
|---|---|
| NextPrevious | Previous-page and next-page buttons. |
| NextPreviousFirstLast | Previous-page, next-page, first-page, and last -page buttons. |
| Numeric | Numbered link buttons to access pages directly. |
| NumericFirstLast | 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 |
|---|---|
| FirstPageText | Text for the first-page button. |
| PreviousPageText | Text for the previous-page button. |
| NextPageText | Text for the next-page button. |
| LastPageText | 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 |
|---|---|
| FirstPageImageUrl | The URL to an image to display for the first-page button. |
| PreviousPageImageUrl | The URL to an image to display for the previous-page button. |
| NextPageImageUrl | The URL to an image to display for the next-page button. |
| LastPageImageUrl | 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.
Constructors
| PagerSettings() |
Initializes a new instance of the PagerSettings class. |
Properties
| FirstPageImageUrl |
Gets or sets the URL to an image to display for the first-page button. |
| FirstPageText |
Gets or sets the text to display for the first-page button. |
| LastPageImageUrl |
Gets or sets the URL to an image to display for the last-page button. |
| LastPageText |
Gets or sets the text to display for the last-page button. |
| Mode |
Gets or sets the mode in which to display the pager controls in a control that supports pagination. |
| NextPageImageUrl |
Gets or sets the URL to an image to display for the next-page button. |
| NextPageText |
Gets or sets the text to display for the next-page button. |
| PageButtonCount |
Gets or sets the number of page buttons to display in the pager when the Mode property is set to the Numeric or NumericFirstLast value. |
| Position |
Gets or sets a value that specifies the location where the pager is displayed. |
| PreviousPageImageUrl |
Gets or sets the URL to an image to display for the previous-page button. |
| PreviousPageText |
Gets or sets the text to display for the previous page button. |
| Visible |
Gets or sets a value indicating whether the paging controls are displayed in a control that supports pagination. |
Methods
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString() |
Retrieves the string representation of a PagerSettings object. |
Events
| PropertyChanged |
Occurs when a property of a PagerSettings object changes values. |
Explicit Interface Implementations
| IStateManager.IsTrackingViewState |
Gets a value that indicates whether the server control is tracking its view state changes. |
| IStateManager.LoadViewState(Object) |
Loads the previously saved view state of the PagerSettings object. |
| IStateManager.SaveViewState() |
Saves the current view state of the PagerSettings object. |
| IStateManager.TrackViewState() |
Marks the starting point at which to begin tracking and saving view state changes to the PagerSettings object. |
