Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

NextPreviousPagerField Class

.NET Framework 4

Represents a field that displays navigation controls in a DataPager control enable users to page through data.

System.Object
  System.Web.UI.WebControls.DataPagerField
    System.Web.UI.WebControls.NextPreviousPagerField

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

The NextPreviousPagerField type exposes the following members.

  Name Description
Public method NextPreviousPagerField Initializes a new instance of the NextPreviousPagerField class.
Top
  Name Description
Public property ButtonCssClass Gets or sets the cascading style sheet (CSS) class that is used to render the buttons of the pager field on the browser.
Public property ButtonType Gets or sets the button type to display in the pager field.
Protected property DataPager Gets a reference to the data pager that the DataPagerField object is associated with. (Inherited from DataPagerField.)
Public property FirstPageImageUrl Gets or sets the URL to an image that is displayed for the first-page button.
Public property FirstPageText Gets or sets the text that is displayed for the first-page button.
Protected property IsTrackingViewState Gets a value that indicates whether the DataPagerField object is tracking its view-state changes. (Inherited from DataPagerField.)
Public property LastPageImageUrl Gets or sets the URL to an image that is displayed for the last-page button in the NextPreviousPagerField object.
Public property LastPageText Gets or sets the text that is displayed for the last-page button.
Public property NextPageImageUrl Gets or sets the URL to an image that is displayed for the next-page button in the NextPreviousPagerField object.
Public property NextPageText Gets or sets the text that is displayed for the next-page button.
Public property PreviousPageImageUrl Gets or sets the URL to an image that is displayed for the previous-page button in the NextPreviousPagerField object.
Public property PreviousPageText Gets or sets the text that is displayed for the previous-page button.
Protected property QueryStringHandled Gets or sets a value that indicates whether the query string field has been evaluated. (Inherited from DataPagerField.)
Protected property QueryStringValue Gets the value of the query string field from the URL of the request. (Inherited from DataPagerField.)
Public property RenderDisabledButtonsAsLabels Gets or sets a value that indicates whether disabled buttons are rendered as Label controls by the NextPreviousPagerField object.
Public property RenderNonBreakingSpacesBetweenControls Gets or sets a value that indicates whether non-breaking spaces are rendered between controls.
Public property ShowFirstPageButton Gets or sets a value that indicates whether the first-page button is displayed in a NextPreviousPagerField object.
Public property ShowLastPageButton Gets or sets a value that indicates whether the last-page button is displayed in a NextPreviousPagerField object.
Public property ShowNextPageButton Gets or sets a value that indicates whether the next-page button is displayed in a NextPreviousPagerField object.
Public property ShowPreviousPageButton Gets or sets a value that indicates whether the previous-page button is displayed in a NextPreviousPagerField object.
Protected property ViewState Gets 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 property Visible Gets or sets a value that indicates whether a data pager field is rendered. (Inherited from DataPagerField.)
Top
  Name Description
Protected method CloneField Infrastructure. Creates a copy of the current object that is derived from DataPagerField. (Inherited from DataPagerField.)
Protected method CopyProperties Copies the properties of the current NextPreviousPagerField object to the specified DataPagerField object. (Overrides DataPagerField.CopyProperties(DataPagerField).)
Public method CreateDataPagers Creates 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 method CreateField Creates and returns a new instance of the NextPreviousPagerField class. (Overrides DataPagerField.CreateField().)
Public method Equals Determines whether the specified object is equal to the current NextPreviousPagerField object. (Overrides Object.Equals(Object).)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for the NextPreviousPagerField class. (Overrides Object.GetHashCode().)
Protected method GetQueryStringNavigateUrl Creates a URL that contains a query string field that has the specified page number. (Inherited from DataPagerField.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method HandleEvent Handles events that occur in the NextPreviousPagerField control and performs the appropriate action. (Overrides DataPagerField.HandleEvent(CommandEventArgs).)
Protected method LoadViewState Restores view-state information that was saved previously. (Inherited from DataPagerField.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnFieldChanged Raises the FieldChanged event. (Inherited from DataPagerField.)
Protected method SaveViewState Saves the changes that were made to the DataPagerField object's view state. (Inherited from DataPagerField.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method TrackViewState 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
  Name Description
Explicit interface implemetation Private property IStateManager.IsTrackingViewState Infrastructure. Gets a value that indicates whether the DataPagerField object is tracking its view-state changes. (Inherited from DataPagerField.)
Explicit interface implemetation Private method IStateManager.LoadViewState Infrastructure. Restores view-state information that was saved previously. (Inherited from DataPagerField.)
Explicit interface implemetation Private method IStateManager.SaveViewState Infrastructure. Saves the changes that were made to the DataPagerField object's view state. (Inherited from DataPagerField.)
Explicit interface implemetation Private method IStateManager.TrackViewState Infrastructure. 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 NextPreviousPagerField class represents a field that displays navigation controls in a DataPager control. These navigation controls can be used to page through data that are displayed by a control that implements the IPageableItemContainer interface, such as the ListView control.

The NextPreviousPagerField class provides buttons that enable users to navigate through the pages of data one page at a time, or to jump to the first or last page of data.

You can customize the appearance of the NextPreviousPagerField object by using the ButtonCssClass property to set the style of the buttons. You can also use the ButtonType property to choose the type of button that is displayed. The following table lists the available button types.

Button type

Description

Button

A Button control.

Image

An ImageButton control.

Link

A LinkButton control.

You can hide a NextPreviousPagerField object in a DataPager control by setting the Visible property to false. You can also hide the individual buttons (the first-page, previous-page, next-page, and last-page buttons) by setting the ShowFirstPageButton, ShowPreviousPageButton, ShowNextPageButton, and ShowLastPageButton properties to false.

The NextPreviousPagerField control enables you to specify custom text for each button by using the FirstPageText, PreviousPageText, NextPageText, and LastPageText properties.

When the ButtonType property is set to ButtonType.Image, you must provide the URL to an image that will be displayed for the button. You can set images individually for each button by setting the FirstPageImageUrl, PreviousPageImageUrl, NextPageImageUrl, and LastPageImageUrl properties.

When the ButtonType property is set to ButtonType.Image, the corresponding text property acts as the alternate text for the image. For example, the text that is specified by the FirstPageText property is displayed as the alternate text for the first-page image button. In browsers that support tooltips, this text is also displayed as a tooltip.

The following example shows how to use a NextPreviousPagerField object to page through data that is displayed in a ListView control.

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>NextPreviousPagerField Example</title>
  </head>
  <body>
    <form id="form1" runat="server">

      <h3>NextPreviousPagerField Example</h3>

      <asp:ListView ID="ContactsListView" 
        DataSourceID="ContactsDataSource"
        runat="server">
        <LayoutTemplate>
          <table cellpadding="2" width="640px" border="1" runat="server" id="tblContacts">
            <tr id="itemPlaceholder" runat="server">
            </tr>
          </table>
        </LayoutTemplate>
        <ItemTemplate>
          <tr runat="server">
            <td>
              <asp:Label ID="ContactIDLabel" runat="server" Text='<%#Eval("ContactID") %>' />
            </td>
            <td>
              <asp:Label ID="FirstNameLabel" runat="server" Text='<%#Eval("FirstName") %>' />
            </td>
            <td>
              <asp:Label ID="LastNameLabel" runat="server" Text='<%#Eval("LastName") %>' />
            </td>
          </tr>
        </ItemTemplate>
      </asp:ListView>

      <asp:DataPager runat="server" ID="ContactsDataPager" PagedControlID="ContactsListView">
        <Fields>
          <asp:NextPreviousPagerField ShowFirstPageButton="true" ShowLastPageButton="true" />
        </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 [ContactID], [FirstName], [LastName] FROM Person.Contact">
      </asp:SqlDataSource>

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

.NET Framework

Supported in: 4, 3.5

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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)
Community Content Add
Annotations FAQ