Click or drag to resize
UniPager Class
UniPager control.
Inheritance Hierarchy

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 11.0.0
Syntax
C#
public class UniPager : CMSWebControl, INamingContainer, 
	IPostBackEventHandler

The UniPager type exposes the following members.

Constructors
  NameDescription
Public methodUniPager
Top
Fields
  NameDescription
Protected fieldmEnvelopeTag
Default envelope tag.
Protected fieldmHTMLEnvelopeRenderingMode
Default envelope rendering mode.
Protected fieldmRelatedData
Custom data connected to the object.
Protected fieldmRelatedDataLoaded
Related data is loaded.
Top
Properties
  NameDescription
Public propertyCurrentPage
Gets or sets the current pages number.
Public propertyCurrentPageTemplate
Current page template.
Public propertyDataSourceItemsCount
Gets or sets the count of items in datasource.
Public propertyDirectPageControlID
Gets or sets the ID of direct page control in template.
Public propertyDirectPageTemplate
Direct page control template.
Public propertyDisplayFirstLastAutomatically
Gets or sets the value that indicates whether first and last items should be displayed only if first or last is not accessible by other way accessible.
Public propertyDisplayPreviousNextAutomatically
Gets or sets the value that indicates whether previous and next items should be displayed only if next or previous is not accessible by other way.
Public propertyEnvelopeTag
Gets or sets the current envelope tag.
Public propertyFilterTypePageControl
Gets or sets the ID of the control to page.
Public propertyFirstPageTemplate
First page template.
Public propertyFirstPageText
Text displayed in first page link.
Public propertyGroupSize
Gets or sets the current pages number.
Public propertyHidePagerForSinglePage
Gets or sets the value that indicates whether pager should be hidden for single page.
Public propertyHTMLEnvelopeRenderingMode
Gets or sets the HTML envelope rendering mode for current pager.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyItemsCount
Gets or sets the current group item size.
Public propertyLastPageTemplate
Last page template.
Public propertyLastPageText
Text displayed in last page link.
Public propertyLayoutTemplate
Layout template.
Public propertyMaxPages
Gets or sets the max. processed pages (only for query string mode and fake number of results).
Public propertyNextGroupTemplate
Next group template.
Public propertyNextGroupText
Text displayed in next group link.
Public propertyNextPageTemplate
Next page template.
Public propertyNextPageText
Text displayed in next page link.
Public propertyPageControl
Gets or sets the ID of the control to page.
Public propertyPageCount
Gets or sets the current number of pages.
Public propertyPagedControl
Paged control.
Public propertyPageNumbersSeparatorTemplate
Page numbers separator template.
Public propertyPageNumbersTemplate
Page numbers summary>
Public propertyPagerMode
Gets or sets the pager mode.
Public propertyPageSize
Gets or sets the page size.
Public propertyPreviousGroupTemplate
Previous group template.
Public propertyPreviousGroupText
Text displayed in previous group link.
Public propertyPreviousPageTemplate
Previous page template.
Public propertyPreviousPageText
Text displayed in previous page link.
Public propertyQueryStringKey
Gets or sets the pager querystring key.
Public propertyRelatedData
Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
Public propertyResetScrollPositionOnPostBack
Reset scroll position on post back action
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertyUseQueryParameterForFirstPage
Gets or sets the value that indicates whether links to the first page should be generated with querystring parameter
Top
Methods
  NameDescription
Protected methodBoundTargetControl
Bound target control.
Public methodConnectToPagedControl
Connects the pager to the given paged control
Protected methodGetCurrentPage
Returns current page.
Public methodGetInnerControl
Returns inner control in layout template control collection.
Protected methodOnInit
OnInit override.
(Overrides CMSWebControlOnInit(EventArgs).)
Protected methodOnLoad
OnLoad override.
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnPreRender
OnPreRender.
(Overrides ControlOnPreRender(EventArgs).)
Public methodProcessItem
Process item.
Public methodRaisePostBackEvent
Raise post back event - handle page change.
Public methodRebindPager
Calls page binding method for initializing pager control and ensures all necessary actions.
Public methodReloadData
Loads data according to the current values of properties.
Protected methodRender
Removes web control default span tag.
(Overrides WebControlRender(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 eventOnBeforeTemplateLoading
Occurs before pager templates are loaded.
Public eventOnPageChanged
Occurs when page is changed.
Top
See Also