Click or drag to resize
DocumentBase Class
Base interface for document pages.
Inheritance Hierarchy
SystemObject
  CMS.UIControlsDocumentBase

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

The DocumentBase type exposes the following members.

Constructors
  NameDescription
Public methodDocumentBase
Constructor.
Top
Fields
  NameDescription
Protected fieldmBodyClass
Generic body class - contains the base body css class.
Protected fieldmBodyParameters
Other parameters in body tag.
Protected fieldmBodyScripts
Top HTML body node for custom HTML code.
Protected fieldmCssFile
Page CSS file link.
Protected fieldmExtendedTags
Extended page tags.
Protected fieldmPageManager
Page manager.
Protected fieldrenderLayout
If false, default layout rendering is disabled.
Top
Properties
  NameDescription
Public propertyBodyClass
Body class.
Public propertyBodyParameters
Body parameters.
Public propertyBodyScripts
Top HTML body node for custom HTML code.
Public propertyStatic memberCacheItems
List of the cache key items.
Public propertyCssFile
CSS file.
Public propertyCurrentPage
Current page.
Public propertyCurrentSite
Current site.
Public propertyCurrentSiteName
Current site name.
Public propertyCurrentStylesheet
Current CSS stylesheet.
Public propertyCurrentUser
Current user.
Public propertyDescription
Description.
Public propertyDocType
DocType.
Protected propertyStatic memberEncodeMetaTagValue
Gets the value that indicates whether meta tags value should be encoded.
Public propertyExtendedTags
Extended tags.
Public propertyFaviconTag
Favicon tag.
Public propertyIsHTML5
Indicates whether DocType of current page is equal to HTML5 DocType.
Public propertyKeyWords
Key words.
Public propertyPage
Document page.
Public propertyPageManager
Page manager.
Public propertyResponse
Current response.
Public propertyTitle
Title.
Public propertyXmlNamespace
Additional XML namespace to HTML tag.
Top
Methods
  NameDescription
Public methodAddCMSTags
Adds the CMS page tags.
Public methodAllowClientCache
Returns true if the full client caching is allowed (no revalidation requests).
Public methodGetHeaderTags
Gets the header tags for current page.
Public methodLoad
Runs the Load actions of the page.
Public methodLogHit
Logs the page hit.
Public methodPreInit
Runs the PreInit actions of the page.
Public methodPreRender
Runs the PreRender actions of the page.
Public methodResolveUrl
Resolves the given URL.
Public methodSetCaching
Sets the page caching.
Public methodSetCSS
Sets the CSS for the page
Public methodSetCulture
Sets the current thread culture according to the user culture.
Public methodSetTheme
Sets the CSS theme for the page.
Top
See Also