CMSTextPager Class

Text-pager control.

Inheritance Hierarchy

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

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

Syntax

public class CMSTextPager : CMSWebControl, 
	INamingContainer

The CMSTextPager type exposes the following members.

Constructors

	Name	Description
Public method	CMSTextPager

Fields

	Name	Description
Protected field	ltlContent	Content literal.
Protected field	ltlSeparator	Separator literal.
Protected field	mDataPager	DataPager variable.
Protected field	mPageSize	Number of chars on a page. If it is -1, the text source is not split.
Protected field	mProcessPlainTextDecoded	If true, the plain text is processed as decoded.
Protected field	mTextSource	Text source property.
Protected field	pagedSource	Paged text source.
Protected field	pnlContent	Content panel.

Properties

	Name	Description
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	PagerControl	Represents pager control.
Public property	PagerCSSClass	Pager CSS class.
Public property	PagerSeparator	Pager separator (HTML code to insert between the paged text and the pager).
Public property	PageSize	Number of chars on a page. If it is -1, the text source is not split.
Public property	ResolveDynamicControls	Gets or sets the value that indicates whether dynamic controls should be resolved
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	TextCSSClass	Text CSS class.
Public property	TextSource	Text source.

Methods

	Name	Description
Protected method	CreateChildControls	Create child controls (Overrides Control.CreateChildControls().)
Protected method	GetDataSet	Gets dataset from string array.
Protected method	OnInit	Init event handler. (Overrides CMSWebControl.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler (Overrides Control.OnLoad(EventArgs).)
Public method	ReloadData	Reloads current data.
Protected method	Render	Render event handler. (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.)