Click or drag to resize
AbstractCMSPage Class
Base page for all the CMS pages.
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 12.0.0
Syntax
C#
public abstract class AbstractCMSPage : Page, 
	ICMSPage

The AbstractCMSPage type exposes the following members.

Constructors
  NameDescription
Protected methodAbstractCMSPage
Constructor
Top
Properties
  NameDescription
Public propertyAfterFormPlaceHolder
Gets placeholder located after form element.
Public propertyStatic memberBlankPageUrl
Returns the URL of a blank page
Public propertyContextMenuContainer
Container control for the context menus.
Public propertyCultureCode
Gets culture code of current document initialized from query string.
Public propertyCurrentUseXUACompatible
If true, X-UA-Compatible header will be added to the page.
Public propertyDocumentID
Gets document ID of current document initialized from query string.
Public propertyDocumentManager
Document manager control.
Protected propertyEnableContextHelp
Tells you whether context help script generation into page is enabled.
Protected propertyEnsureDocumentManager
Indicates if document manager should be ensured
Public propertyEnsurePreferredCulture
Indicates if content preferred culture should be ensured.
Public propertyFooterContainer
Container control for the page footers.
Public propertyHeaderActions
Local header actions
Public propertyIsCMSDesk
Determines whether the current page is located under the CMS Desk.
Public propertyIsDialog
Indicates whether page is a dialog. False by default.
Public propertyIsRootDialog
Indicates whether page is root dialog (top dialog page with header and footer)
Protected propertyIsStandardPage
If true, the page is a UI page
Public propertyLogsContainer
Container control for the log controls.
Public propertyManagersContainer
Container control for the page managers.
Public propertyMessagesPlaceHolder
Local page messages placeholder
Public propertyNodeID
Gets node ID of current document initialized from query string.
Protected propertyRegisterGlobalHotKeyScript
Gets or sets the value that indicates whether global hotkey script should be registered
Public propertyScriptManagerControl
Script manager control.
Public propertyTabMode
Indicates if the page is in tab mode.
Public propertyTree
Tree provider object.
Public propertyUIContext
Page's UI context
Public propertyUseViewStateUserKey
If true, ViewStateUserKey is used.
Public propertyStatic memberUseXUACompatible
Globally enables or disables addition of X-UA-Compatible header to the page.
Public propertyStatic memberXUACompatibleValue
Defines content of X-UA-Compatible header that will be rendered to the page.
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
Public methodAddError
Adds error text to existing message on the page.
Public methodAddHeaderAction
Adds specified action to the page header actions.
Public methodAddHeaderActions
Adds the list of header actions to the page header actions.
Public methodAddInformation
Adds information text to existing message on the page.
Public methodAddMessage
Adds text to existing message on the page.
Public methodAddWarning
Adds warning text to existing message on the page.
Protected methodCreateDocumentManager
Creates a document manager for this page.
Public methodEnsureFootersControl
Ensures the page footer control.
Public methodEnsureScriptManager
Ensures the script manager on the page.
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
Public methodEvalReturnType(String)
Templated Eval, returns the value converted to specific type.
Public methodEvalBool
Evaluates the item data and converts it to the bool.
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
Public methodEvalDecimal
Evaluates the item data and converts it to the decimal.
Public methodEvalDouble
Evaluates the item data and converts it to the double.
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
Public methodEvalText
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
Protected methodGetDocumentManagerContainer
Gets control ideal for containing document manager.
Public methodGetImageUrl
Gets UI image URL.
Public methodStatic memberGetString
Returns localized string.
Public methodInitDebug
Initializes the debug controls.
Protected methodLoadContextHelp
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 methodLoadUserControl
Loads the user control based on the given path
Public methodLogAndShowError
Logs the exception and displays a general error message
Protected methodOnInit
Page initialization.
(Overrides PageOnInit(EventArgs).)
Protected methodOnPreInit
PreInit event handler.
(Overrides PageOnPreInit(EventArgs).)
Protected methodOnPreRender
Page PreRender
(Overrides ControlOnPreRender(EventArgs).)
Protected methodOnPreRenderComplete
Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered.
(Overrides PageOnPreRenderComplete(EventArgs).)
Public methodRegisterBodyModifyingScript
Registers script that modified body element. (For IE7,8 compatibility reasons. See KB927917 for more information.)
Protected methodRegisterContextHelpScript
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 methodResolveUrl
Resolves the given URL
Protected methodSetFormAction
Sets the form action for current page if was rewritten by URL rewriter
Public methodShowChangesSaved
Shows the general changes saved message.
Public methodShowConfirmation
Shows the general confirmation message.
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
Public methodShowMessage
Shows the specified message, optionally with a tooltip text and description.
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
Top
Extension Methods
  NameDescription
Public Extension MethodAddToHeader
Adds the given HTML code to the header of the page.
(Defined by PageExtensions.)
Public Extension MethodCallHandled
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodLoadUserControl
Loads the user control based on the given path
(Defined by ControlsExtensions.)
Top
See Also