Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

NumericPagerField Class

Represents a DataPager field that enables users to select a page by page number.

System.Object
  System.Web.UI.WebControls.DataPagerField
    System.Web.UI.WebControls.NumericPagerField

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)
public class NumericPagerField : DataPagerField

The NumericPagerField type exposes the following members.

  NameDescription
Public methodNumericPagerFieldInitializes a new instance of the NumericPagerField class.
Top
  NameDescription
Public propertyButtonCountGets or sets the number of buttons to display in a NumericPagerField object.
Public propertyButtonTypeGets or sets the button type to display in the pager field.
Public propertyCurrentPageLabelCssClassGets or sets the cascading style sheet (CSS) class that is used to style the current page number.
Protected propertyDataPagerGets a reference to the data pager that the DataPagerField object is associated with. (Inherited from DataPagerField.)
Protected propertyIsTrackingViewStateGets a value that indicates whether the DataPagerField object is tracking its view-state changes. (Inherited from DataPagerField.)
Public propertyNextPageImageUrlGets or sets the URL of an image that is displayed for the next-page button in the NumericPagerField object.
Public propertyNextPageTextGets or sets the text that is displayed for the next-page button.
Public propertyNextPreviousButtonCssClassGets or sets the cascading style sheet (CSS) class that is used to style the next-page and previous-page buttons of the pager field.
Public propertyNumericButtonCssClassGets or sets the cascading style sheet (CSS) class that is used to style the page-number buttons of the pager field.
Public propertyPreviousPageImageUrlGets or sets the URL of an image that is displayed for the previous-page button in the NumericPagerField object.
Public propertyPreviousPageTextGets or sets the text that is displayed for the previous-page button.
Protected propertyQueryStringHandledGets or sets a value that indicates whether the query string field has been evaluated. (Inherited from DataPagerField.)
Protected propertyQueryStringValueGets the value of the query string field from the URL of the request. (Inherited from DataPagerField.)
Public propertyRenderNonBreakingSpacesBetweenControlsGets or sets a value that indicates whether non-breaking spaces will be rendered between controls.
Protected propertyViewStateGets a dictionary of state information that enables you to save and restore the view state of a DataPagerField object across multiple requests for the same page. (Inherited from DataPagerField.)
Public propertyVisibleGets or sets a value that indicates whether a data pager field is rendered. (Inherited from DataPagerField.)
Top
  NameDescription
Protected methodCloneFieldInfrastructure. Creates a copy of the current object that is derived from DataPagerField. (Inherited from DataPagerField.)
Protected methodCopyPropertiesCopies the properties of the current NumericPagerField object to the specified DataPagerField object. (Overrides DataPagerField.CopyProperties(DataPagerField).)
Public methodCreateDataPagersCreates the user interface (UI) controls for the pager field object and adds them to the specified container. (Overrides DataPagerField.CreateDataPagers(DataPagerFieldItem, Int32, Int32, Int32, Int32).)
Protected methodCreateFieldCreates and returns a new instance of the NumericPagerField class. (Overrides DataPagerField.CreateField().)
Public methodEqualsDetermines whether the specified object is equal to the current NumericPagerField object. (Overrides Object.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for the NumericPagerField class. (Overrides Object.GetHashCode().)
Protected methodGetQueryStringNavigateUrlCreates a URL that contains a query string field that has the specified page number. (Inherited from DataPagerField.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodHandleEventHandles events that occur in the NumericPagerField object and performs the appropriate action. (Overrides DataPagerField.HandleEvent(CommandEventArgs).)
Protected methodLoadViewStateRestores view-state information that was saved previously. (Inherited from DataPagerField.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnFieldChangedRaises the FieldChanged event. (Inherited from DataPagerField.)
Protected methodSaveViewStateSaves the changes that were made to the DataPagerField object's view state. (Inherited from DataPagerField.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodTrackViewStateCauses the DataPagerField object to track changes to its view state so that they can be stored in the control's ViewState property and persisted across requests for the same page. (Inherited from DataPagerField.)
Top
  NameDescription
Explicit interface implemetationPrivate propertyIStateManager.IsTrackingViewStateInfrastructure. Gets a value that indicates whether the DataPagerField object is tracking its view-state changes. (Inherited from DataPagerField.)
Explicit interface implemetationPrivate methodIStateManager.LoadViewStateInfrastructure. Restores view-state information that was saved previously. (Inherited from DataPagerField.)
Explicit interface implemetationPrivate methodIStateManager.SaveViewStateInfrastructure. Saves the changes that were made to the DataPagerField object's view state. (Inherited from DataPagerField.)
Explicit interface implemetationPrivate methodIStateManager.TrackViewStateInfrastructure. Causes the DataPagerField object to track changes to its view state so that they can be stored in the control's ViewState property and persisted across requests for the same page. (Inherited from DataPagerField.)
Top

The NumericPagerField class displays navigation controls in a DataPager control. The controls can be used to page through data that is displayed by a control that implements the IPageableItemContainer interface, such as the ListView control. The NumericPagerField object displays page numbers as buttons that users can click to move to specific a page. The control also displays next-page and previous-page buttons that enable users to access more pages of data than the ones that are displayed by the control.

You can customize the appearance of the NumericPagerField object by using the properties that are listed in the following table.

Property

Description

CurrentPageLabelCssClass

The CSS class for the current page number.

NextPreviousButtonCssClass

The CSS class for the next-page and previous-page buttons.

NumericButtonCssClass

The CSS class for the buttons that represent the page numbers.

You can use the ButtonType property to select the type of button that will be displayed. The following table lists the available button types.

Button type

Description

ButtonType.Button

A Button control.

ButtonType.Image

An ImageButton control.

ButtonType.Link

A LinkButton control.

The controls inside the NumericButtonCssClass object are rendered with non-breaking spaces between them. If you want to customize this behavior, you can use the RenderNonBreakingSpacesBetweenControls property.

You can hide a NumericPagerField object in a DataPager control by setting the Visible property to false. You cannot control the visibility of the next-page and previous-page buttons. They are displayed by the control if the associated data control has additional pages available to display. You can use the ButtonCount property to specify how many buttons are displayed in a NumericPagerField object. Each button corresponds to a page number.

You can set the text of the next-page button by setting the NextPageText property. You can set the text of the previous-page button by using the PreviousPageText property.

When the ButtonType property is set to ButtonType.Image, you must provide the URL of an image that will be displayed for the next-page and previous page buttons. You do this by setting the NextPageImageUrl and PreviousPageImageUrl properties. In that case, the corresponding text property is used as the alternate text for the image. For example, the text that is specified by the NextPageImageUrl property is displayed as the alternate text for the next-page image button. On browsers that support tooltips, this text is also displayed as a tooltip for the corresponding button.

The following example shows how to use a NumericPagerField object to page through data that is displayed in a ListView 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 id="Head1" runat="server">
    <title>NumericPagerField Example</title>    
    <style type="text/css">
      body 	
      {
      	text-align: center;
      	font: 12px Arial, Helvetica, sans-serif;
      } 
      table
      {
      	padding: 2px 2px 2px 2px;
      	border: 1px solid;
      	width: 500px;
      }     
      .CurrentPage 
      {
      	padding: 2px 6px;
      	border: solid 1px #ddd; 
      	background: #2E8B57;
      	color:White;
      }
      .PrevNext,.PageNumber
      {
      	padding: 2px 6px;
      	border: solid 1px #ddd;
      	text-decoration: none;
      	color: #2E8B57;
      }
      .PageNumber:hover, .PrevNext:hover
      {
      	background-color: #FFA500;
      	color: White;
      }
    </style>
  </head>
  <body>
    <form id="form1" runat="server">

      <h3>NumericPagerField Example</h3>

      <asp:ListView ID="ContactsListView" 
        DataSourceID="ContactsDataSource"
        runat="server">
        <LayoutTemplate>
          <table runat="server" id="tblContacts">
            <tr id="itemPlaceholder" runat="server">
            </tr>
          </table>
        </LayoutTemplate>
        <ItemTemplate>
          <tr runat="server">
            <td>
              <asp:Label ID="IDLabel" runat="server" Text='<%#Eval("ContactID") %>' />
            </td>
            <td align="left">
              <asp:Label ID="NameLabel" runat="server" 
                Text='<%#Eval("LastName") + ", " + Eval("FirstName")%>' />
            </td>
          </tr>
        </ItemTemplate>
      </asp:ListView>
      <br />

      <div>
        <asp:DataPager runat="server" 
          ID="ContactsDataPager" 
          PagedControlID="ContactsListView">
          <Fields>
            <asp:NumericPagerField 
              PreviousPageText="&lt; Prev"
              NextPageText="Next &gt;"
              ButtonCount="10"
              NextPreviousButtonCssClass="PrevNext"
              CurrentPageLabelCssClass="CurrentPage"
              NumericButtonCssClass="PageNumber" />
          </Fields>
        </asp:DataPager>
      </div>
      <br />

      <!-- This example uses Microsoft SQL Server and connects      -->
      <!-- to the AdventureWorks sample database. Use an ASP.NET    -->
      <!-- expression to retrieve the connection string value       -->
      <!-- from the Web.config file.                                -->
      <asp:SqlDataSource ID="ContactsDataSource" runat="server" 
        ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"
        SelectCommand="SELECT [ContactID], [FirstName], [LastName] 
          FROM Person.Contact">
      </asp:SqlDataSource>

    </form>
  </body>
</html>

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5

Windows Phone 8.1, Windows Phone 8, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.