TemplatePage Class

Base class for the ASPX page template pages.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.Page
        CMS.UIControls.AbstractCMSPage
          CMS.UIControls.ContentPage
            CMS.UIControls.TemplatePage

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

Syntax

public abstract class TemplatePage : ContentPage

The TemplatePage type exposes the following members.

Constructors

	Name	Description
Protected method	TemplatePage

Fields

	Name	Description
Protected field	mDocumentBase	Document base. (Inherited from ContentPage.)

Properties

	Name	Description
Public property	AfterFormPlaceHolder	Gets placeholder located after form element. (Inherited from AbstractCMSPage.)
Public property	BodyClass	Body class. (Inherited from ContentPage.)
Public property	ContextMenuContainer	Container control for the context menus. (Inherited from AbstractCMSPage.)
Public property	CssFile	Css file. (Inherited from ContentPage.)
Public property	CultureCode	Gets culture code of current document initialized from query string. (Inherited from AbstractCMSPage.)
Public property	CurrentPage	Current page info. (Inherited from ContentPage.)
Public property	CurrentSite	Current site. (Inherited from ContentPage.)
Public property	CurrentUser	Current user. (Inherited from ContentPage.)
Public property	CurrentUseXUACompatible	If true, X-UA-Compatible header will be added to the page. (Inherited from AbstractCMSPage.)
Public property	Description	Description. (Inherited from ContentPage.)
Public property	DocumentBase	Document base. (Inherited from ContentPage.)
Public property	DocumentID	Gets document ID of current document initialized from query string. (Inherited from AbstractCMSPage.)
Public property	DocumentManager	Document manager control. (Inherited from AbstractCMSPage.)
Protected property	EnableContextHelp	Tells you whether context help script generation into page is enabled. (Inherited from AbstractCMSPage.)
Protected property	EnsureDocumentManager	Indicates if document manager should be ensured (Inherited from AbstractCMSPage.)
Public property	EnsurePreferredCulture	Indicates if content preferred culture should be ensured. (Inherited from AbstractCMSPage.)
Public property	ExtendedTags	Extended tags. (Inherited from ContentPage.)
Public property	FooterContainer	Container control for the page footers. (Inherited from AbstractCMSPage.)
Public property	HeaderActions	Local header actions (Inherited from AbstractCMSPage.)
Public property	HeaderTags	Header tags. (Inherited from ContentPage.)
Public property	IsCMSDesk	Determines whether the current page is located under the CMS Desk. (Inherited from AbstractCMSPage.)
Public property	IsDialog	Indicates whether page is a dialog. False by default. (Inherited from AbstractCMSPage.)
Public property	IsRootDialog	Indicates whether page is root dialog (top dialog page with header and footer) (Inherited from AbstractCMSPage.)
Protected property	IsStandardPage	If true, the page is a UI page (Inherited from AbstractCMSPage.)
Public property	KeyWords	Key words. (Inherited from ContentPage.)
Public property	ManagersContainer	Container control for the page managers. (Inherited from AbstractCMSPage.)
Public property	MessagesPlaceHolder	Local page messages placeholder (Inherited from AbstractCMSPage.)
Public property	NodeID	Gets node ID of current document initialized from query string. (Inherited from AbstractCMSPage.)
Public property	PageManager	Page manager. (Inherited from ContentPage.)
Public property	PageTitle	Title. (Inherited from ContentPage.)
Public property	ScriptManagerControl	Script manager control. (Inherited from AbstractCMSPage.)
Public property	TabMode	Indicates if the page is in tab mode. (Inherited from AbstractCMSPage.)
Public property	Tree	Tree provider object. (Inherited from AbstractCMSPage.)
Public property	UIContext	Page's UI context (Inherited from AbstractCMSPage.)
Public property	XmlNamespace	Additional XML namespace to HTML tag. (Inherited from ContentPage.)

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractCMSPage.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractCMSPage.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractCMSPage.)
Public method	AddHeaderActions	Adds the list of header actions to the page header actions. (Inherited from AbstractCMSPage.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractCMSPage.)
Public method	AddMessage	Adds text to existing message on the page. (Inherited from AbstractCMSPage.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractCMSPage.)
Protected method	CreateDocumentManager	Creates a document manager for this page. (Inherited from AbstractCMSPage.)
Public method	EnsureFootersControl	Ensures the page footer control. (Inherited from AbstractCMSPage.)
Public method	EnsureScriptManager	Ensures the script manager on the page. (Inherited from ContentPage.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractCMSPage.)
Public method	Eval<ReturnType>(String)	Templated Eval, returns the value converted to specific type. (Inherited from AbstractCMSPage.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractCMSPage.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractCMSPage.)
Public method	EvalDecimal	Evaluates the item data and converts it to the decimal. (Inherited from AbstractCMSPage.)
Public method	EvalDouble	Evaluates the item data and converts it to the double. (Inherited from AbstractCMSPage.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractCMSPage.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractCMSPage.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractCMSPage.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractCMSPage.)
Public method	EvalText	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractCMSPage.)
Protected method	GetDocumentManagerContainer	Gets document manager container (Inherited from ContentPage.)
Public method	GetImageUrl	Gets UI image URL. (Inherited from AbstractCMSPage.)
Protected method	LoadContextHelp	Loads application description and help topics with respect to current UI context. Does nothing when context help not enabled or not on standard page. (Inherited from AbstractCMSPage.)
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractCMSPage.)
Public method	LogAndShowError	Logs the exception and displays a general error message (Inherited from AbstractCMSPage.)
Protected method	OnInit	Init event handler. (Inherited from ContentPage.)
Protected method	OnLoad	Load event handler. (Inherited from ContentPage.)
Protected method	OnPreInit	PreInit event handler. (Inherited from ContentPage.)
Protected method	OnPreRender	PreRender event handler. (Inherited from ContentPage.)
Protected method	OnPreRenderComplete	Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered. (Inherited from AbstractCMSPage.)
Protected method	OnUnload	Unload event handler. (Inherited from ContentPage.)
Public method	RegisterBodyModifyingScript	Registers script that modified body element. (For IE7,8 compatibility reasons. See KB927917 for more information.) (Inherited from AbstractCMSPage.)
Protected method	RegisterContextHelpScript	Registers script which passes application description and help topics to UI. If applicationName is null or empty, no application context is assumed (and applicationDescriptionUrl, applicationHelpTopics is not used). (Inherited from AbstractCMSPage.)
Protected method	Render	Render event handler. (Inherited from ContentPage.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractCMSPage.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractCMSPage.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractCMSPage.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractCMSPage.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractCMSPage.)
Public method	ShowMessage	Shows the specified message, optionally with a tooltip text and description. (Inherited from AbstractCMSPage.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractCMSPage.)

Extension Methods

	Name	Description
Public Extension Method	AddToHeader	Adds the given HTML code to the header of the page. (Defined by PageExtensions.)
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	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	LoadUserControl	Loads the user control based on the given path (Defined by ControlsExtensions.)