UniPager Class

UniPager control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.DocumentEngine.Web.UI.UniPager

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 11.0.0

Syntax

public class UniPager : CMSWebControl, INamingContainer, 
	IPostBackEventHandler

The UniPager type exposes the following members.

Constructors

	Name	Description
Public method	UniPager

Fields

	Name	Description
Protected field	mEnvelopeTag	Default envelope tag.
Protected field	mHTMLEnvelopeRenderingMode	Default envelope rendering mode.
Protected field	mRelatedData	Custom data connected to the object.
Protected field	mRelatedDataLoaded	Related data is loaded.

Properties

	Name	Description
Public property	CurrentPage	Gets or sets the current pages number.
Public property	CurrentPageTemplate	Current page template.
Public property	DataSourceItemsCount	Gets or sets the count of items in datasource.
Public property	DirectPageControlID	Gets or sets the ID of direct page control in template.
Public property	DirectPageTemplate	Direct page control template.
Public property	DisplayFirstLastAutomatically	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 property	DisplayPreviousNextAutomatically	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 property	EnvelopeTag	Gets or sets the current envelope tag.
Public property	FilterTypePageControl	Gets or sets the ID of the control to page.
Public property	FirstPageTemplate	First page template.
Public property	FirstPageText	Text displayed in first page link.
Public property	GroupSize	Gets or sets the current pages number.
Public property	HidePagerForSinglePage	Gets or sets the value that indicates whether pager should be hidden for single page.
Public property	HTMLEnvelopeRenderingMode	Gets or sets the HTML envelope rendering mode for current pager.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	ItemsCount	Gets or sets the current group item size.
Public property	LastPageTemplate	Last page template.
Public property	LastPageText	Text displayed in last page link.
Public property	LayoutTemplate	Layout template.
Public property	MaxPages	Gets or sets the max. processed pages (only for query string mode and fake number of results).
Public property	NextGroupTemplate	Next group template.
Public property	NextGroupText	Text displayed in next group link.
Public property	NextPageTemplate	Next page template.
Public property	NextPageText	Text displayed in next page link.
Public property	PageControl	Gets or sets the ID of the control to page.
Public property	PageCount	Gets or sets the current number of pages.
Public property	PagedControl	Paged control.
Public property	PageNumbersSeparatorTemplate	Page numbers separator template.
Public property	PageNumbersTemplate	Page numbers summary>
Public property	PagerMode	Gets or sets the pager mode.
Public property	PageSize	Gets or sets the page size.
Public property	PreviousGroupTemplate	Previous group template.
Public property	PreviousGroupText	Text displayed in previous group link.
Public property	PreviousPageTemplate	Previous page template.
Public property	PreviousPageText	Text displayed in previous page link.
Public property	QueryStringKey	Gets or sets the pager querystring key.
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
Public property	ResetScrollPositionOnPostBack	Reset scroll position on post back action
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	UseQueryParameterForFirstPage	Gets or sets the value that indicates whether links to the first page should be generated with querystring parameter

Methods

	Name	Description
Protected method	BoundTargetControl	Bound target control.
Public method	ConnectToPagedControl	Connects the pager to the given paged control
Protected method	GetCurrentPage	Returns current page.
Public method	GetInnerControl	Returns inner control in layout template control collection.
Protected method	OnInit	OnInit override. (Overrides CMSWebControl.OnInit(EventArgs).)
Protected method	OnLoad	OnLoad override. (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreRender	OnPreRender. (Overrides Control.OnPreRender(EventArgs).)
Public method	ProcessItem	Process item.
Public method	RaisePostBackEvent	Raise post back event - handle page change.
Public method	RebindPager	Calls page binding method for initializing pager control and ensures all necessary actions.
Public method	ReloadData	Loads data according to the current values of properties.
Protected method	Render	Removes web control default span tag. (Overrides WebControl.Render(HtmlTextWriter).)

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	CallHandled	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 Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnBeforeTemplateLoading	Occurs before pager templates are loaded.
Public event	OnPageChanged	Occurs when page is changed.