Click or drag to resize
TemplateDataPager Class
Template data pager.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      CMS.Base.Web.UICMSWebControl
        CMS.DocumentEngine.Web.UIBasicDataPager
          CMS.DocumentEngine.Web.UITemplateDataPager

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class TemplateDataPager : BasicDataPager

The TemplateDataPager type exposes the following members.

Constructors
  NameDescription
Public methodTemplateDataPager
Top
Fields
  NameDescription
Protected fieldmDataSource
DataSource.
(Inherited from BasicDataPager.)
Protected fieldmMaxPages
Max. pages.
(Inherited from BasicDataPager.)
Protected fieldmPagedData
Paged data.
(Inherited from BasicDataPager.)
Protected fieldmPagingMode
Paging mode.
(Inherited from BasicDataPager.)
Protected fieldmUniqueID
Unique ID.
(Inherited from BasicDataPager.)
Top
Properties
  NameDescription
Public propertyCurrentPage
Current page number.
(Inherited from BasicDataPager.)
Public propertyDataSource
Pager DataSource.
(Inherited from BasicDataPager.)
Public propertyFirstItemTemplate
First item template.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyLastItemTemplate
Last item tamplate.
Public propertyMaxPages
Maximum number of pages to be displayed.
(Inherited from BasicDataPager.)
Public propertyNextItemTemplate
Next item template.
Public propertyNumberRepeater
Number repeater.
Public propertyNumberTemplate
Number template.
Public propertyPageCount
Page count.
(Inherited from BasicDataPager.)
Public propertyPagedData
Paged data.
(Inherited from BasicDataPager.)
Public propertyPagerPosition
Pager position.
(Inherited from BasicDataPager.)
Public propertyPageSize
Page size.
(Inherited from BasicDataPager.)
Public propertyPagingMode
Determines if PostBack or QueryString should be used for the paging.
(Inherited from BasicDataPager.)
Public propertyPreviousItemTemplate
Previous item template.
Public propertyRecordEnd
Index of the last record on current page.
(Inherited from BasicDataPager.)
Public propertyRecordStart
Index of the first record on current page.
(Inherited from BasicDataPager.)
Public propertySelectedNumberTemplate
Selected number template.
Public propertySeparatorTemplate
Number template.
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Inherited from BasicDataPager.)
Public propertyTotalRecords
Total data source records.
(Inherited from BasicDataPager.)
Public propertyUniqueID
Unique ID.
(Inherited from BasicDataPager.)
Top
Methods
  NameDescription
Protected methodCreateChildControls
Creates child controls.
(Overrides ControlCreateChildControls.)
Public methodGetBackNextLocation
Returns back/next type based on the given string.
(Inherited from BasicDataPager.)
Public methodGetItemDataRow
Returns the DataRow for the given item index.
(Inherited from BasicDataPager.)
Public methodGetItemPage
Returns the page of selected item (start with 1)
(Inherited from BasicDataPager.)
Public methodGetPagerPosition
Returns the pager position based on the given string.
(Inherited from BasicDataPager.)
Public methodGetPagingMode
Returns the paging mode based on the given string.
(Inherited from BasicDataPager.)
Public methodGetResultPosition
Returns the result position based on the given string.
(Inherited from BasicDataPager.)
Protected methodOnInit
Init event handler.
(Inherited from CMSWebControl.)
Protected methodOnPreRender
OnPreRender.
(Overrides ControlOnPreRender(EventArgs).)
Public methodRaiseOnDataSourceChanged
Raises the OnDataSourceChanged event.
(Inherited from BasicDataPager.)
Public methodRaiseOnPageChange
Raises the OnPageChange event.
(Inherited from BasicDataPager.)
Public methodReloadData
Reloads data for pager with current settings.
Protected methodRender
Render.
(Overrides BasicDataPagerRender(HtmlTextWriter).)
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false.
(Defined by ControlsExtensions.)
Public Extension MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventOnDataSourceChanged
Data source change event.
(Inherited from BasicDataPager.)
Public eventOnPageChange
Page change event.
(Inherited from BasicDataPager.)
Top
See Also