Click or drag to resize
UIPager Class
Base class for the UI Pager control
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 12.0.0
Syntax
C#
public abstract class UIPager : CMSUserControl

The UIPager type exposes the following members.

Constructors
  NameDescription
Protected methodUIPager
Top
Fields
  NameDescription
Protected fieldStatic memberDEFAULT_PAGE_SIZE_OPTIONS
Contains default page size options.
Protected fieldStatic memberPAGE_SIZE_QUERYSTRING_KEY
Constant for query-string key of page size value. Used with PagerMode set to 'QueryString'.
Top
Properties
  NameDescription
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyControlContext
Control context.
(Inherited from CMSUserControl.)
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPage
Returns current page.
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentPageSize
Gets or sets current page size.
Public propertyCurrentResolver
Control's resolver
(Inherited from CMSUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDefaultPageSize
Default page size at first load.
Public propertyDirectPageControlID
Direct page controls ID for UniPager control..
Public propertyDisplayMode
Gets or sets display mode of the control.
(Inherited from CMSUserControl.)
Public propertyDisplayPager
Indicates if whole pager should be displayed.
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from CMSUserControl.)
Public propertyFirstPageText
Text displayed in first page link.
Public propertyGroupSize
Number of pages visible in one group of pages.
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyHidePagerForSinglePage
Gets or sets the value that indicates whether pager should be hidden for single page.
Public propertyIsCMSDesk
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyLastPageText
Text displayed in last page link.
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyNextGroupText
Text displayed in next group link.
Public propertyNextPageText
Text displayed in next page link.
Public propertyPagedControl
Paged control for UniPager.
Public propertyPagerMode
Gets or sets the pager mode.
Public propertyPageSizeDropdown
PageSize dropdown control.
Public propertyPageSizeOptions
Page size values separates with comma. Macro ##ALL## indicates that all the results will be displayed at one page.
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Public propertyPreviousGroupText
Text displayed in previous group link.
Public propertyPreviousPageText
Text displayed in previous page link.
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyQueryStringKey
String used as query string parameter for paging
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyShowDirectPageControl
Indicates if direct page control should be visible.
Public propertyShowFirstLastButtons
Indicates if first and last button should be visible.
Public propertyShowPageSize
Indicates if page size dropdown list should be visible.
Public propertyShowPreviousNextButtons
Indicates if previous and next button should be visible.
Public propertyShowPreviousNextPageGroup
Indicates if previous and next page group button should be visible.
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyUIContext
Control's UI Context
(Inherited from CMSUserControl.)
Public propertyUniPager
UniPager control.
Public propertyUseCMSDeskAccessDeniedPage
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Protected methodGetAccessDeniedPageUrl
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Public methodGetValue(String)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
Load event handler.
(Inherited from AbstractUserControl.)
Protected methodOnPreRender
OnPreRender event handler.
(Overrides AbstractUserControlOnPreRender(EventArgs).)
Public methodRedirectToAccessDenied(String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(Int32, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(String, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToUIElementAccessDenied
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Public methodReleaseContext
Releases the control context.
(Inherited from CMSUserControl.)
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodReset
Resets the current paging.
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSetContext
Sets the control context.
(Inherited from CMSUserControl.)
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
Protected methodTryParsePageSizeOptions
Parses given string containing page size options.
Top
Extension Methods
  NameDescription
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
See Also