Home Library Learn Samples Downloads Support Community Forums
This topic has not yet been rated - Rate this topic

DataPagerField Class

.NET Framework 4.5

Serves as the base class for data pager field types, which represent a navigation control for the DataPager control.

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)
C#
C++
F#
VB
Copy 
public abstract class DataPagerField : IStateManager

The DataPagerField type exposes the following members.

  NameDescription
Protected methodDataPagerFieldInitializes a new instance of the DataPagerField class.
Top
  NameDescription
Protected propertyDataPagerGets a reference to the data pager that the DataPagerField object is associated with.
Protected propertyIsTrackingViewStateGets a value that indicates whether the DataPagerField object is tracking its view-state changes.
Protected propertyQueryStringHandledGets or sets a value that indicates whether the query string field has been evaluated.
Protected propertyQueryStringValueGets the value of the query string field from the URL of the request.
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.
Public propertyVisibleGets or sets a value that indicates whether a data pager field is rendered.
Top
  NameDescription
Protected methodCloneFieldInfrastructure. Creates a copy of the current object that is derived from DataPagerField.
Protected methodCopyPropertiesCopies the properties of the current object derived from DataPagerField to the specified DataPagerField object.
Public methodCreateDataPagersWhen overridden in a derived class, creates the user interface (UI) controls for the data pager field object and adds them to the specified container.
Protected methodCreateFieldWhen overridden in a derived class, creates an empty object that is derived DataPagerField.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from 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 a particular type. (Inherited from Object.)
Protected methodGetQueryStringNavigateUrlCreates a URL that contains a query string field that has the specified page number.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodHandleEventWhen overridden in a derived class, handles events that occur in the data pager field object.
Protected methodLoadViewStateRestores view-state information that was saved previously.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnFieldChangedRaises the FieldChanged event.
Protected methodSaveViewStateSaves the changes that were made to the DataPagerField object's view state.
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.
Top
  NameDescription
Explicit interface implemetationPrivate propertyIStateManager.IsTrackingViewStateInfrastructure. Gets a value that indicates whether the DataPagerField object is tracking its view-state changes.
Explicit interface implemetationPrivate methodIStateManager.LoadViewStateInfrastructure. Restores view-state information that was saved previously.
Explicit interface implemetationPrivate methodIStateManager.SaveViewStateInfrastructure. Saves the changes that were made to the DataPagerField object's view state.
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.
Top

The DataPagerField class serves as the base class for all data pager field types. Data pager fields are used by the DataPager control to represent a navigation control.

Use the classes that are derived from DataPagerField to select which type of pager is displayed in the DataPager control. The following table lists available data pager field types.

Pager field type

Description

NextPreviousPagerField

Lets users navigate through data pages one page at a time, or to jump to the first or last page.

NumericPagerField

Lets users select a page by page number.

TemplatePagerField

Lets page developers create a custom paging UI.

You can derive from the DataPagerField class to create additional pager field types.

Notes to Inheritors

When you inherit from the DataPagerField class, you must override the following members:

The following example shows how to use NextPreviousPagerField, NumericPagerField, and TemplatePagerField objects to display page navigation controls in a DataPager control. The objects are derived from the DataPagerField class.

C#
VB
Copy 
<%@ 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>DataPagerField Example</title>    
    <style type="text/css">
      body  
      {
      	text-align: center; 
      	font: 13px Tahoma, Arial, Helvetica;
      }
      .item
      {
        border-bottom: solid 1px #FFA500;
        font-weight:bold;
      }
    </style>
  </head>
  <body>
    <form id="form1" runat="server">

      <h3>DataPagerField Example</h3>

      <asp:ListView ID="ProductsListView" 
        DataSourceID="ContactsDataSource"
        runat="server">
        <LayoutTemplate>
          <table runat="server" id="tblProducts" width="350">
            <tr runat="server" id="itemPlaceholder" />
          </table>
        </LayoutTemplate>
        <ItemTemplate>
          <tr runat="server">
            <td class="item">
              <asp:Label ID="NameLabel" runat="server" 
                Text='<%#Eval("Name") %>' />
            </td>
          </tr>
          <tr runat="server">
            <td>
              <asp:Label ID="DescriptionLabel" runat="server" 
                Text='<%#Eval("Description")%>' />
            </td>
          </tr>
        </ItemTemplate>
        <ItemSeparatorTemplate>
          <tr runat="server">
            <td>&nbsp;</td>
          </tr>
        </ItemSeparatorTemplate>
      </asp:ListView>
      <br />

      <asp:DataPager runat="server" 
        ID="ProductsDataPager" 
        PageSize="5"
        PagedControlID="ProductsListView">
        <Fields>
          <asp:TemplatePagerField>
            <PagerTemplate>
            <b>
            Page
            <asp:Label runat="server" ID="CurrentPageLabel" 
              Text="<%# Container.TotalRowCount>0 ? (Container.StartRowIndex / Container.PageSize) + 1 : 0 %>" />
            of
            <asp:Label runat="server" ID="TotalPagesLabel" 
              Text="<%# Math.Ceiling ((double)Container.TotalRowCount / Container.PageSize) %>" />
            </b>
            <br /><br />
            </PagerTemplate>
          </asp:TemplatePagerField>

          <asp:NextPreviousPagerField
            ShowFirstPageButton="true"
            ShowNextPageButton="false"
            ShowPreviousPageButton="false" />

          <asp:NumericPagerField 
            PreviousPageText="&lt;&lt;"
            NextPageText="&gt;&gt;"
            ButtonCount="10" />

          <asp:NextPreviousPagerField
            ShowLastPageButton="true"
            ShowNextPageButton="false"
            ShowPreviousPageButton="false" />
        </Fields>
      </asp:DataPager>

      <!-- 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 P.Name, PD.Description 
                      FROM Production.ProductModel AS PM 
                      INNER JOIN Production.Product AS P ON PM.ProductModelID = P.ProductModelID 
                      INNER JOIN Production.ProductModelProductDescriptionCulture AS PMPDC 
                      ON PM.ProductModelID = PMPDC.ProductModelID 
                      INNER JOIN Production.ProductDescription AS PD 
                      ON PMPDC.ProductDescriptionID = PD.ProductDescriptionID 
                      WHERE (PMPDC.CultureID = 'en')">
      </asp:SqlDataSource>

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

.NET Framework

Supported in: 4.5, 4, 3.5

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)
© 2013 Microsoft. All rights reserved.