TemplateDataPager

The TemplateDataPager control provides a pager with a customizable format. You can use the TemplateDataPager with the following controls:

• CMSDataList
• CMSRepeater
• CMSSearchResults
• QueryDataList
• QueryRepeater

The TemplateDataPager automatically renders the list of numbers, but you need to write the code that binds the pager to the control that displays the data.

Getting started

The following is a step-by-step tutorial that shows how to use the TemplateDataPager control with a CMSRepeater control that displays Smartphones (CMS.Smartphone pages):

1. Create a new Web form somewhere in your web project.

2. Add the following code to the page, inside the <form> element:

   Copy

   
   
   
    <asp:ScriptManager ID="manScript" runat="server" ScriptMode="Release" EnableViewState="false" />
   
    <table style="border: solid 1px #CCCCCC; margin-left: auto; margin-right: auto;">
        <tr>
          <td style="border-bottom: solid 1px #CCCCCC; padding: 10px; text-align: center;">
            <cms:CMSRepeater ID="CMSRepeater1" runat="server" Path="/%" ClassNames="CMS.Smartphone" TransformationName="CorporateSite.Transformations.ProductList" />
          </td>
        </tr>
        <tr>
          <td style="padding: 10px; background-color: #D9D9D9;">
          <cms:TemplateDataPager ID="TemplateDataPager1" runat="server">
              <NumberTemplate>
                  <a href="?Page=<%# Eval("PageNumber")  %>">
                    <%# Eval("PageNumber")  %>
                  </a>
              </NumberTemplate>
              <SelectedNumberTemplate>
                  <b>
                    <%# Eval("PageNumber")  %>
                  </b>
              </SelectedNumberTemplate>
              <SeparatorTemplate>
                  -
              </SeparatorTemplate>
              <FirstItemTemplate>
                  <a href="?Page=1">First</a>&nbsp;|&nbsp;
              </FirstItemTemplate>
              <LastItemTemplate>
                  &nbsp;|&nbsp;<a href="?Page=<%# pageCount %>">Last</a>
              </LastItemTemplate>
              <PreviousItemTemplate>
                  <a href="?Page=<%# previousPage %>">Previous</a> &nbsp;|&nbsp;
              </PreviousItemTemplate>
              <NextItemTemplate>
                  &nbsp;|&nbsp; <a href="?Page=<%# nextPage %>">Next</a>
              </NextItemTemplate>
          </cms:TemplateDataPager>
   
          </td>
        </tr>
    </table>
   
   
    

   The web form uses a standard CMSRepeater control to display data. The pager format is specified using the templates defined between the tags of the <cms: TemplateDataPager> element.

   The ScriptManager control included at the top is required by the transformation used to display smartphone pages. It is only there to ensure that the web form is functional as a standalone example. Typically, the ScriptManager is included on the website’s master page.

3. Edit the web form’s code behind according to the following (the class name and type may be different):

   Copy

   
   
   
    using CMS.Helpers;
   
    public partial class CMSControlsExamples_TemplateDataPager : System.Web.UI.Page
    {
        public string pageCount = "1";
        public string previousPage = "1";
        public string nextPage = "";
   
        protected void Page_Load(object sender, EventArgs e)
        {
            // Gets the repeater's data source
            TemplateDataPager1.DataSource = CMSRepeater1.DataSource;
   
            // Sets the page size
            TemplateDataPager1.PageSize = 1;
   
            // Loads the current page number from the URL query string
            TemplateDataPager1.CurrentPage = ValidationHelper.GetInteger(Request.QueryString["Page"], 1);
   
            // Gets the page number for the last link 
            pageCount = ((int)(TemplateDataPager1.PageCount - 1)).ToString();
   
            // Sets the default next page link
            nextPage = pageCount;
   
            // Sets the previous link
            if ((TemplateDataPager1.CurrentPage - 1) >= 1)
            {
                previousPage = ((int)(TemplateDataPager1.CurrentPage - 1)).ToString();
            }
   
            // Sets the next link
            if ((TemplateDataPager1.CurrentPage + 1) <= (TemplateDataPager1.PageCount - 1))
            {
                nextPage = ((int)(TemplateDataPager1.CurrentPage + 1)).ToString();
            }
   
            // Assigns the paged datasource to the repeater and binds it
            CMSRepeater1.DataSource = TemplateDataPager1.PagedData;
            if (!DataHelper.DataSourceIsEmpty(CMSRepeater1.DataSource))
            {
                CMSRepeater1.DataBind();
            }
        }
    }
   
   
    

4. Save the web form.

5. Right-click the web form in the Solution explorer and select View in Browser.

The control displays a customized pager:

Configuration

You can set the following properties for the TemplateDataPager control:

Appearance and styling

The appearance of the TemplateDataPager control is determined by the code of its item templates. You can define the following templates:

<a href="?Page=1">First</a>&nbsp;|&nbsp;

&nbsp;|&nbsp;<a href="?Page=<%# pageCount %>">Last</a>

&nbsp;|&nbsp; <a href="?Page=<%# nextPage %>">Next</a>

<a href="?Page=<%# Eval("PageNumber")  %>">
<%# Eval("PageNumber")  %>
</a>

<a href="?Page=<%# previousPage %>">Previous</a> &nbsp;|&nbsp;

<b>
<%# Eval("PageNumber")  %>
</b>

-