NextPreviousPagerField Class
TOC
Collapse the table of content
Expand the table of content

NextPreviousPagerField Class

.NET Framework (current version)
 

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

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

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

public class NextPreviousPagerField : DataPagerField

NameDescription
System_CAPS_pubmethodNextPreviousPagerField()

Initializes a new instance of the NextPreviousPagerField class.

NameDescription
System_CAPS_pubpropertyButtonCssClass

Gets or sets the cascading style sheet (CSS) class that is used to render the buttons of the pager field on the browser.

System_CAPS_pubpropertyButtonType

Gets or sets the button type to display in the pager field.

System_CAPS_protpropertyDataPager

Gets a reference to the data pager that the DataPagerField object is associated with. (Inherited from DataPagerField.)

System_CAPS_pubpropertyFirstPageImageUrl

Gets or sets the URL to an image that is displayed for the first-page button.

System_CAPS_pubpropertyFirstPageText

Gets or sets the text that is displayed for the first-page button.

System_CAPS_protpropertyIsTrackingViewState

Gets a value that indicates whether the DataPagerField object is tracking its view-state changes.(Inherited from DataPagerField.)

System_CAPS_pubpropertyLastPageImageUrl

Gets or sets the URL to an image that is displayed for the last-page button in the NextPreviousPagerField object.

System_CAPS_pubpropertyLastPageText

Gets or sets the text that is displayed for the last-page button.

System_CAPS_pubpropertyNextPageImageUrl

Gets or sets the URL to an image that is displayed for the next-page button in the NextPreviousPagerField object.

System_CAPS_pubpropertyNextPageText

Gets or sets the text that is displayed for the next-page button.

System_CAPS_pubpropertyPreviousPageImageUrl

Gets or sets the URL to an image that is displayed for the previous-page button in the NextPreviousPagerField object.

System_CAPS_pubpropertyPreviousPageText

Gets or sets the text that is displayed for the previous-page button.

System_CAPS_protpropertyQueryStringHandled

Gets or sets a value that indicates whether the query string field has been evaluated.(Inherited from DataPagerField.)

System_CAPS_protpropertyQueryStringValue

Gets the value of the query string field from the URL of the request.(Inherited from DataPagerField.)

System_CAPS_pubpropertyRenderDisabledButtonsAsLabels

Gets or sets a value that indicates whether disabled buttons are rendered as Label controls by the NextPreviousPagerField object.

System_CAPS_pubpropertyRenderNonBreakingSpacesBetweenControls

Gets or sets a value that indicates whether non-breaking spaces are rendered between controls.

System_CAPS_pubpropertyShowFirstPageButton

Gets or sets a value that indicates whether the first-page button is displayed in a NextPreviousPagerField object.

System_CAPS_pubpropertyShowLastPageButton

Gets or sets a value that indicates whether the last-page button is displayed in a NextPreviousPagerField object.

System_CAPS_pubpropertyShowNextPageButton

Gets or sets a value that indicates whether the next-page button is displayed in a NextPreviousPagerField object.

System_CAPS_pubpropertyShowPreviousPageButton

Gets or sets a value that indicates whether the previous-page button is displayed in a NextPreviousPagerField object.

System_CAPS_protpropertyViewState

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.)

System_CAPS_pubpropertyVisible

Gets or sets a value that indicates whether a data pager field is rendered.(Inherited from DataPagerField.)

NameDescription
System_CAPS_protmethodCloneField()

This API supports the product infrastructure and is not intended to be used directly from your code. Creates a copy of the current object that is derived from DataPagerField.(Inherited from DataPagerField.)

System_CAPS_protmethodCopyProperties(DataPagerField)

Copies the properties of the current NextPreviousPagerField object to the specified DataPagerField object.(Overrides DataPagerField.CopyProperties(DataPagerField).)

System_CAPS_pubmethodCreateDataPagers(DataPagerFieldItem, Int32, Int32, Int32, Int32)

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).)

System_CAPS_protmethodCreateField()

Creates and returns a new instance of the NextPreviousPagerField class.(Overrides DataPagerField.CreateField().)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current NextPreviousPagerField object.(Overrides Object.Equals(Object).)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as a hash function for the NextPreviousPagerField class.(Overrides Object.GetHashCode().)

System_CAPS_protmethodGetQueryStringNavigateUrl(Int32)

Creates a URL that contains a query string field that has the specified page number.(Inherited from DataPagerField.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodHandleEvent(CommandEventArgs)

Handles events that occur in the NextPreviousPagerField control and performs the appropriate action.(Overrides DataPagerField.HandleEvent(CommandEventArgs).)

System_CAPS_protmethodLoadViewState(Object)

Restores view-state information that was saved previously. (Inherited from DataPagerField.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnFieldChanged()

Raises the FieldChanged event.(Inherited from DataPagerField.)

System_CAPS_protmethodSaveViewState()

Saves the changes that were made to the DataPagerField object's view state.(Inherited from DataPagerField.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodTrackViewState()

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.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.LoadViewState(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Restores view-state information that was saved previously. (Inherited from DataPagerField.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.SaveViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Saves the changes that were made to the DataPagerField object's view state.(Inherited from DataPagerField.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.TrackViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. 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.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIStateManager.IsTrackingViewState

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates whether the DataPagerField object is tracking its view-state changes.(Inherited from DataPagerField.)

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.

<%@ 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
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft