Click or drag to resize
DataPager Class
Control for supporting the data paging within the databound controls.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      CMS.Base.Web.UICMSWebControl
        CMS.DocumentEngine.Web.UIBasicDataPager
          CMS.DocumentEngine.Web.UIDataPager

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
[SerializableAttribute]
public class DataPager : BasicDataPager, IPostBackEventHandler

The DataPager type exposes the following members.

Constructors
  NameDescription
Public methodDataPager
Constructor.
Top
Fields
  NameDescription
Protected fieldmBackNextButtonStyle
Back next button style
Protected fieldmBackNextDisplay
Back next display.
Protected fieldmBackNextLinkSeparator
Back next link separator
Protected fieldmBackNextLocation
Back next location.
Protected fieldmBackNextStyle
Back next style.
Protected fieldmBackText
BackText.
Protected fieldmControlCssClass
Control css class.
Protected fieldmControlStyle
Control style.
Protected fieldmDataSource
DataSource.
(Inherited from BasicDataPager.)
Protected fieldmFirstText
FirstText.
Protected fieldmHideOnSinglePage
Hide on single page.
Protected fieldmIgnoreQueryString
Ignore query string.
Protected fieldmLabelStyle
Label style.
Protected fieldmLabelText
Label text.
Protected fieldmLastText
LastText.
Protected fieldmMaxPages
Max. pages.
(Inherited from BasicDataPager.)
Protected fieldmNextText
NextText.
Protected fieldmPagedData
Paged data.
(Inherited from BasicDataPager.)
Protected fieldmPageNumbersDisplay
Page numbers display.
Protected fieldmPageNumbersSeparator
Page numbers separator.
Protected fieldmPageNumbersStyle
Page numbers style.
Protected fieldmPageNumberStyle
Page number style.
Protected fieldmPagerHTMLAfter
After pager html.
Protected fieldmPagerHTMLBefore
Befor pager html.
Protected fieldmPagerNumbersClass
Number area CSS class.
Protected fieldmPagingMode
Paging mode.
(Inherited from BasicDataPager.)
Public fieldmQueryStringKey
Query string key.
Protected fieldmRenderedHtml
Render Html.
Protected fieldmResultsClass
Results CSS class.
Protected fieldmResultsFormat
Results format.
Protected fieldmResultsLocation
Results location.
Protected fieldmResultsStyle
Results style.
Protected fieldmSectionPadding
Section padding.
Protected fieldmSelectedClass
Class of selected page.
Protected fieldmSelectedNextClass
Class of selected next.
Protected fieldmSelectedPrevClass
Class of selected previous.
Protected fieldmShowFirstLast
Show FirstLast.
Protected fieldmShowLabel
Show label.
Protected fieldmShowPageNumbers
Show page numbers.
Protected fieldmSliderSize
Slider size.
Protected fieldmUniqueID
Unique ID.
(Inherited from BasicDataPager.)
Protected fieldmUnselectedClass
Class of unselected page.
Protected fieldmUnselectedNextClass
Class of unselected next.
Protected fieldmUnselectedPrevClass
Class of unselected previous.
Protected fieldmUseSlider
Use slider.
Top
Properties
  NameDescription
Public propertyBackNextButtonStyle
BackNext button style.
Public propertyBackNextDisplay
BackNext display.
Public propertyBackNextLinkSeparator
BackNext link separator.
Public propertyBackNextLocation
BackNext location.
Public propertyBackNextStyle
BackNext style.
Public propertyBackText
Back button/hyperlink text
Public propertyControlCssClass
CSS Class of the pager control.
Public propertyCurrent
Current page number.
Public propertyCurrentPage
Current page number.
(Inherited from BasicDataPager.)
Public propertyDataSource
Pager DataSource.
(Overrides BasicDataPagerDataSource.)
Public propertyFirstText
First text.
Public propertyHideOnSinglePage
If true, the pager is hidden if only one page is displayed.
Public propertyIgnoreQueryString
Indicates if QueryString parameters should be ignored.
Public propertyInsertKeys
Keys to be added to querystring.
Public propertyInsertToUrl
Check if insert is enabled.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyLabelStyle
Label style.
Public propertyLabelText
Label text.
Public propertyLastText
Last text.
Public propertyMaxPages
Maximum number of pages to be displayed.
(Inherited from BasicDataPager.)
Public propertyNextText
Next button/hyperlink text
Public propertyPageCount
Page count.
(Inherited from BasicDataPager.)
Public propertyPagedData
Paged data.
(Inherited from BasicDataPager.)
Public propertyPageNumbersDisplay
Page numbers display mode.
Public propertyPageNumbersSeparator
Page numbers separator.
Public propertyPageNumbersStyle
Page numbers style.
Public propertyPageNumberStyle
Page number style.
Public propertyPagerControlStyle
Pager control style.
Public propertyPagerHTMLAfter
After pager html.
Public propertyPagerHTMLBefore
Before pager html.
Public propertyPagerNumberAreaClass
Pager number area CSS class.
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 propertyQueryStringKey
Query parameter name for the page index.
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 propertyRemoveFromUrl
Check if remove is enabled.
Public propertyRemoveKeys
Keys to remove.
Public propertyRenderedHtml
Rendered html ???
Public propertyResultsClass
Results CSS class.
Public propertyResultsFormat
Results text format.
Public propertyResultsLocation
Results location.
Public propertyResultsStyle
Results style.
Public propertySectionPadding
Section padding.
Public propertySelectedClass
Class of selected page.
Public propertySelectedNextClass
Class of selected next.
Public propertySelectedPrevClass
Class of selected prev.
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertyShowFirstLast
Show first last labels.
Public propertyShowLabel
Show label.
Public propertyShowPageNumbers
Show page numbers.
Public propertySliderSize
Slider size.
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Overrides BasicDataPagerTagKey.)
Public propertyTotalRecords
Total data source records.
(Inherited from BasicDataPager.)
Public propertyUniqueID
Unique ID.
(Inherited from BasicDataPager.)
Public propertyUnselectedClass
Class of unselected page.
Public propertyUnselectedNextClass
Class of unselected next.
Public propertyUnselectedPrevClass
Class of unselected prev.
Public propertyUseSlider
Use slider.
Top
Methods
  NameDescription
Public methodBindToQueryString
Bind to query.
Protected methodBuildButtonNavBack
Build button Back navigation.
Protected methodBuildButtonNavNext
Build button Next navigation.
Public methodBuildControl
Build control.
Protected methodBuildLinkNavBack
Build Back/Next link navigation
Protected methodBuildLinkNavNext
Build link Next navigation.
Protected methodBuildPageNumbers
Build page number links.
Public methodBuildResults
Build results
Protected methodBuildResultsArea
Build results.
Public methodChangePage
Change page.
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 methodLoadViewState
Load ViewState.
(Overrides WebControlLoadViewState(Object).)
Public methodOnClick
Invokes delegates registered with the Click event.
Protected methodOnInit
Init event handler.
(Inherited from CMSWebControl.)
Public methodProcessPageIndex
Make same action like PreRender function.
Public methodRaiseOnDataSourceChanged
Raises the OnDataSourceChanged event.
(Inherited from BasicDataPager.)
Public methodRaiseOnPageChange
Raises the OnPageChange event.
(Inherited from BasicDataPager.)
Public methodRaisePostBackEvent
Method of IPostBackEventHandler that raises change events.
Protected methodRender
Render this control to the output parameter specified.
(Overrides BasicDataPagerRender(HtmlTextWriter).)
Protected methodSaveViewState
Save ViewState.
(Overrides WebControlSaveViewState.)
Public methodUpdateQueryStringItem
Updates current URL with new items.
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 eventClick
Defines the Click event.
Public eventOnDataSourceChanged
Data source change event.
(Inherited from BasicDataPager.)
Public eventOnPageChange
Page change event.
(Inherited from BasicDataPager.)
Public eventViewStateLoaded
Event is raised after view state load.
Top
See Also