DocumentBase Class

Base interface for document pages.

Inheritance Hierarchy

System.Object
  CMS.UIControls.DocumentBase

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23

Syntax

public class DocumentBase

The DocumentBase type exposes the following members.

Constructors

	Name	Description
Public method	DocumentBase	Constructor.

Methods

	Name	Description
Public method	AddCMSTags	Adds the CMS page tags.
Public method	AddComponentsCSS	Obsolete. Adds the CSS for the components
Public method	AllowClientCache	Returns true if the full client caching is allowed (no revalidation requests).
Public method	GetHeaderTags	Gets the header tags for current page.
Public method	Load	Runs the Load actions of the page.
Public method	LogHit	Logs the page hit.
Public method	PreInit	Runs the PreInit actions of the page.
Public method	PreRender	Runs the PreRender actions of the page.
Public method	ResolveUrl	Resolves the given URL.
Public method	SetCaching	Sets the page caching.
Public method	SetCSS	Sets the CSS for the page
Public method	SetCulture	Sets the current thread culture according to the user culture.
Public method	SetTheme	Sets the CSS theme for the page.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mBodyClass	Generic body class - contains the base body css class.
Protected field	mBodyParameters	Other parameters in body tag.
Protected field	mCssFile	Page CSS file link.
Protected field	mExtendedTags	Extended page tags.
Protected field	mPageManager	Page manager.
Protected field	renderLayout	If false, default layout rendering is disabled.

Properties

	Name	Description
Public property	BodyClass	Body class.
Public property	BodyParameters	Body parameters.
Public property Static member	CacheItems	List of the cache key items.
Public property	CssFile	CSS file.
Public property	CurrentPage	Current page.
Public property	CurrentSite	Current site.
Public property	CurrentSiteName	Current site name.
Public property	CurrentStylesheet	Current CSS stylesheet.
Public property	CurrentUser	Current user.
Public property	Description	Description.
Public property	DocType	DocType.
Protected property Static member	EncodeMetaTagValue	Gets the value that indicates whether meta tags value should be encoded.
Public property	ExtendedTags	Extended tags.
Public property	FavIconTag	Shortcut icon file path.
Public property	IsHTML5	Indicates whether DocType of current page is equal to HTML5 DocType.
Public property	KeyWords	Key words.
Public property	Page	Document page.
Public property	PageManager	Page manager.
Public property	Response	Current response.
Public property	Title	Title.
Public property	XmlNamespace	Additional XML namespace to HTML tag.