AbstractCMSPage Class

Base page for all the CMS pages.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.Page
        CMS.UIControls.AbstractCMSPage
          CMS.UIControls.CMSPage
          CMS.UIControls.ContentPage
          CMS.UIControls.GetFilePage
          CMS.UIControls.XMLPage

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

Syntax

public abstract class AbstractCMSPage : Page, 
	ICMSPage

The AbstractCMSPage type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractCMSPage	Constructor

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page.
Public method	AddError	Adds error text to existing message on the page.
Public method	AddHeaderAction	Adds specified action to the page header actions.
Public method	AddHeaderActions	Adds the list of header actions to the page header actions.
Public method	AddInformation	Adds information text to existing message on the page.
Public method	AddMessage	Adds text to existing message on the page.
Public method	AddWarning	Adds warning text to existing message on the page.
Public method	EnsureFootersControl	Ensures the page footer control.
Public method	EnsureScriptManager	Ensures the script manager on the page.
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding.
Public method	Eval<ReturnType>(String)	Templated Eval, returns the value converted to specific type.
Public method	EvalBool	Evaluates the item data and converts it to the bool.
Public method	EvalDateTime	Evaluates the item data and converts it to the date time.
Public method	EvalDouble	Evaluates the item data and converts it to the integer.
Public method	EvalGuid	Evaluates the item data and converts it to the guid.
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
Public method	EvalInteger	Evaluates the item data and converts it to the integer.
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
Public method	EvalText	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
Protected method	GetDocumentManagerContainer	Gets control ideal for containing document manager.
Public method	GetImageUrl	Gets UI image URL.
Public method	GetObjectIconUrl	Obsolete. Gets the icon for the given object type.
Public method Static member	GetString	Returns localized string.
Public method	InitDebug	Initializes the debug controls.
Public method	InitDevTools	Initializes the Dev tools menu
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.
Public method	LoadUserControl	Loads the user control based on the given path
Public method	LogAndShowError	Logs the exception and displays a general error message
Protected method	OnInit	Page initialization. (Overrides Page.OnInit(EventArgs).)
Protected method	OnPreInit	PreInit event handler. (Overrides Page.OnPreInit(EventArgs).)
Protected method	OnPreRender	Page PreRender (Overrides Control.OnPreRender(EventArgs).)
Protected method	OnPreRenderComplete	Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered. (Overrides Page.OnPreRenderComplete(EventArgs).)
Public method	RegisterBodyModifyingScript	Registers script that modified body element. (For IE7,8 compatibility reasons. See KB927917 for more information.)
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).
Public method	ResolveUrl	Resolves the given URL
Protected method	SetFormAction	Sets the form action for current page if was rewritten by URL rewriter
Public method	ShowConfirmation	Shows the general confirmation message.
Public method	ShowError	Shows the specified error message, optionally with a tooltip text.
Public method	ShowChangesSaved	Shows the general changes saved message.
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text.
Public method	ShowMessage	Shows the specified message, optionally with a tooltip text and description.
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text.

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	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	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	LoadUserControl	Loads the user control based on the given path (Defined by ControlsExtensions.)
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	mContextMenuContainer	Container control for the context menus.
Protected field	mDocumentManager	Document manager control.
Protected field	mFootersContainer	Container control for the page footers.
Protected field	mHeaderActions	Header actions
Protected field	mLogsContainer	Container control for the log controls.
Protected field	mManagersContainer	Container control for the page managers.
Protected field	mScriptManagerControl	Script manager control.

Properties

	Name	Description
Public property	AfterFormPlaceHolder	Gets placeholder located after form element.
Public property Static member	BlankPageUrl	Returns the URL of a blank page
Public property	ContextMenuContainer	Container control for the context menus.
Public property	CultureCode	Gets culture code of current document initialized from query string.
Public property	CurrentUseXUACompatible	If true, X-UA-Compatible header will be added to the page.
Public property	DocumentID	Gets document ID of current document initialized from query string.
Public property	DocumentManager	Document manager control.
Protected property	EnableContextHelp	Tells you whether context help script generation into page is enabled.
Protected property	EnsureDocumentManager	Indicates if document manager should be ensured
Public property	EnsurePreferredCulture	Indicates if content preferred culture should be ensured.
Public property	FooterContainer	Container control for the page footers.
Public property	HeaderActions	Local header actions
Public property	IsCMSDesk	Determines whether the current page is located under the CMS Desk.
Public property	IsDialog	Indicates whether page is a dialog. False by default.
Public property	IsRootDialog	Indicates whether page is root dialog (top dialog page with header and footer)
Protected property	IsStandardPage	If true, the page is a UI page
Public property	LogsContainer	Container control for the log controls.
Public property	ManagersContainer	Container control for the page managers.
Public property	MessagesPlaceHolder	Local page messages placeholder
Public property	NodeID	Gets node ID of current document initialized from query string.
Protected property	RegisterGlobalHotKeyScript	Gets or sets the value that indicates whether global hotkey script should be registered
Public property	ScriptManagerControl	Script manager control.
Public property	TabMode	Indicates if the page is in tab mode.
Public property	Tree	Tree provider object.
Public property	UIContext	Page's UI context
Public property	UseViewStateUserKey	If true, ViewStateUserKey is used.
Public property Static member	UseXUACompatible	Globally enables or disables addition of X-UA-Compatible header to the page.
Public property Static member	XUACompatibleValue	Defines content of X-UA-Compatible header that will be rendered to the page.