CMSPage Class

Base page for all CMS administration UI pages

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.Page
        CMS.UIControls.AbstractCMSPage
          CMS.UIControls.CMSPage
            More...

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

Syntax

public abstract class CMSPage : AbstractCMSPage, 
	IAdminPage

The CMSPage type exposes the following members.

Constructors

	Name	Description
Protected method	CMSPage

Fields

	Name	Description
Public field Static member	EXPORT_OBJECT_HEIGHT	Height of the export object modal window
Public field Static member	EXPORT_OBJECT_WIDTH	Width of the export object modal window
Protected field	mAddBaseTag	Indicates whether base tag should be added
Protected field	mBodyClass	Generic body class - contains the base body CSS class
Protected field	mContextMenuContainer	Container control for the context menus. (Inherited from AbstractCMSPage.)
Protected field	mCurrentMaster	Current master page
Protected field	mCurrentSiteName	Current site name
Protected field	mCurrentUser	Current user
Protected field	mFootersContainer	Container control for the page footers. (Inherited from AbstractCMSPage.)
Protected field	mHeaderActions	Header actions (Inherited from AbstractCMSPage.)
Protected field	mInstallPage	Indicates whether current page is install page
Protected field	mLogsContainer	Container control for the log controls. (Inherited from AbstractCMSPage.)
Protected field	mLogViewState	Log page ViewState
Protected field	mManagersContainer	Container control for the page managers. (Inherited from AbstractCMSPage.)
Protected field	mPageStatusContainer	Page status container
Protected field	mRegisterWOpener	Indicates whether wOpeber is loaded
Protected field	mRelativePath	Relative path
Protected field	mScriptManagerControl	Script manager control. (Inherited from AbstractCMSPage.)

Properties

	Name	Description
Public property	AddBaseTag	Gets or sets the value that indicates whether base tag with target _self should be added to the header
Public property	AfterFormPlaceHolder	Gets placeholder located after form element. (Inherited from AbstractCMSPage.)
Public property	BodyClass	Body class
Public property	ContextMenuContainer	Container control for the context menus. (Inherited from AbstractCMSPage.)
Public property	CultureCode	Gets culture code of current document initialized from query string. (Inherited from AbstractCMSPage.)
Public property	CurrentMaster	Current CMSMasterPage page
Public property	CurrentSiteName	Current site name
Protected property	CurrentUser	Current user
Public property	CurrentUseXUACompatible	If true, X-UA-Compatible header will be added to the page. (Inherited from AbstractCMSPage.)
Public property	DisableAdministrationInterface	If true, the administration interface is disabled
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.)
Public property Static member	EditedDocument	Document edited by the current page. If set to NULL, redirects to the information page with information that document has been deleted.
Public property	EditedObject	Object edited by the current page. If set to NULL, redirects to the information page with information that object has been deleted.
Public property	EditedObjectParent	Parent of object edited by the current page. If set to NULL, redirects to the information page with information that object has been deleted.
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	FooterContainer	Container control for the page footers. (Inherited from AbstractCMSPage.)
Public property Static member	FooterFrameHeight	Height of frame with footer
Public property	HeaderActions	Local header actions (Inherited from AbstractCMSPage.)
Public property	CheckHashValidationAttribute
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.)
Public property Static member	IsScreenLocked	Indicates if screen is locked.
Protected property	IsStandardPage	If true, the page is a UI page (Inherited from AbstractCMSPage.)
Public property Static member	LastRequest	Time of last request (not counting ScreenLock callbacks).
Public property	LogsContainer	Container control for the log controls. (Inherited from AbstractCMSPage.)
Public property	ManagersContainer	Container for the page and script managers (Overrides AbstractCMSPage.ManagersContainer.)
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	PageBreadcrumbs	Page title
Protected property	PageStatusContainer	Page status container
Public property	PageTitle	Page title
Public property	PersistentEditedObject	Special property allowing to treat edited object as non-static property Usable when you need to store information about edited object and then after post back reload it based on id and object type
Protected property	RegisterGlobalHotKeyScript	Gets or sets the value that indicates whether global hotkey script should be registered (Inherited from AbstractCMSPage.)
Protected property	RegisterPageLoadedScript	Indicates if page loaded script should be registered.
Public property	RegisterWOpener	If true, the page registers the wopener JavaScript variable
Public property	RelativePath	Page relative path
Public property	RequiresDialog	Gets or sets the value that indicates whether the page is displayed as dialog.
Public property	ScriptManagerControl	Script manager control. (Inherited from AbstractCMSPage.)
Protected property	SplitModeAllwaysRefresh	Indicates if split mode frame should be refreshed always on post-back (even for different cultures).
Public property	TabMode	Indicates if the page is in tab mode. (Inherited from AbstractCMSPage.)
Public property Static member	TabsFrameHeight	Height of frame with tabs
Public property Static member	TabsOnlyHeight	Height of frame containing tabs only
Public property Static member	TitleOnlyHeight	Height of frame containing title only
Public property	Tree	Tree provider object. (Inherited from AbstractCMSPage.)
Public property	TypeName	Returns the object type name
Public property	UIContext	Page's UI context (Inherited from AbstractCMSPage.)
Public property	UseViewStateUserKey	If true, ViewStateUserKey is used. (Inherited from AbstractCMSPage.)

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	AddNoCacheTag	Adds the no-cache tag to the page header
Public method	AddScript	Adds the script to the page
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractCMSPage.)
Public method	DisableDebugging	Disables all debugging for current page
Public method	EnsureFootersControl	Ensures the page footer control. (Inherited from AbstractCMSPage.)
Public method	EnsureScriptManager	Ensures the script manager on the page. (Overrides AbstractCMSPage.EnsureScriptManager().)
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	EvalDouble	Evaluates the item data and converts it to the integer. (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.)
Public method Static member	GetAccessDeniedUrl	Gets the URL to Access denied page
Public method Static member	GetCMSDeskUIElementAccessDenied	Gets the URL for CMS Desk Access denied page
Protected method	GetDocumentManagerContainer	Gets control ideal for containing document manager. (Inherited from AbstractCMSPage.)
Public method	GetImageUrl	Gets UI image URL. (Inherited from AbstractCMSPage.)
Public method	CheckAdministrationInterface	Checks if the administration interface is enabled, if not, redirects to access denied
Public method	CheckEditor	Checks whether the user is an editor
Public method	CheckGlobalAdministrator	Checks whether user is global administrator with access to all applications User without global access is redirected to access denied page.
Public method	CheckLicense	Checks the license for the given feature. Redirects to feature not available if not available.
Public method	CheckPermissions	Checks the security of the permissions, returns true if the security check succeeded
Public method Static member	CheckPreferredCulture()	Checks the preferred culture and changes it to default if not valid. Returns true if the culture was valid.
Public method Static member	CheckPreferredCulture(String)	Checks the preferred culture and changes it to default if not valid. Returns true if the culture was valid.
Public method	CheckResourceSite	Checks the security of the resource, returns true if the module is assigned to the site
Public method	CheckSite	Checks if current site is valid. Redirects to invalid web site if not.
Public method Static member	CheckUIElementAccessHierarchical(UIElementInfo, MacroResolver, Int32, Boolean)	Checks the permissions of all UI elements hierarchically starting with specified UI element. Use optional parameter (contextResolver) and macro in ElementAccessCondition will be also checked. Use two optional parameters (isDialog, rootElementId) if your ui element is dialog. In case of insufficient permissions appropriate redirection is made.
Public method Static member	CheckUIElementAccessHierarchical(String, String, MacroResolver, Int32, Boolean)	Checks the permissions of all UI elements hierarchically starting with specified UI element. Use optional parameter "contextResolver" and macro in ElementAccessCondition will be also checked. Use optional parameter "rootElementId" if your UI element is in a dialog. RootElementId variable identifies the UI element which is used in the top frame of the dialog. In case of insufficient permissions appropriate redirection is made.
Public method	CheckUIElements	Checks the security of the UI elements, returns true if the security check succeeded
Public method	InitDebug	Initializes the debug controls. (Inherited from AbstractCMSPage.)
Public method	InitDevTools	Initializes the Dev tools menu (Inherited from AbstractCMSPage.)
Public method	InitTabs(String)	Initializes the array for the tabs data
Public method	InitTabs(String, String, String)	Initializes the array for the tabs data
Public method Static member	IsUserAuthorizedPerContent()	Determines whether current user is authorized to access cms.content
Public method Static member	IsUserAuthorizedPerContent(String)	Determines whether current user is authorized to access cms.content
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 (Overrides AbstractCMSPage.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreInit	PreInit event handler (Overrides AbstractCMSPage.OnPreInit(EventArgs).)
Protected method	OnPreRender	PreRender event handler (Overrides AbstractCMSPage.OnPreRender(EventArgs).)
Protected method	OnPreRenderComplete	Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered. (Inherited from AbstractCMSPage.)
Public method	RaiseCheckTabSecurity	Raises OnCheckTabSecurity event.
Public method	RaiseTabCreated	Raises OnTabCreated event.
Public method Static member	RedirectToAccessDenied(String)	Redirects the user to Access denied page
Public method Static member	RedirectToAccessDenied(String, String)	Redirects the user to Access denied page
Protected method Static member	RedirectToAccessDenied(String, String, String, String, String)	Redirects the user to Access denied page
Protected method Static member	RedirectToAccessDeniedPage	Redirects the user to Access denied page
Public method Static member	RedirectToAccessDeniedResourceNotAvailableOnSite	Redirect to access denied page with error text not available on site
Public method Static member	RedirectToInformation	Redirects the user to the info page which displays specified message.
Public method Static member	RedirectToResourceNotAvailableOnSite	Redirects the user to the access denied page with info about resource not being assigned to site.
Public method Static member	RedirectToSecured	Redirects to secured (SSL) page if its set in settings (CMSUseSSLForAdministrationInterface key)
Public method Static member	RedirectToUIElementAccessDenied	Redirects the user to CMS Desk Access denied page
Public method Static member	RedirectToUINotAvailable	Redirects the user to the info page which says that the UI of the requested page is not available.
Public method Static member	RefreshParentWindow	Refreshes the parent window
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.)
Public method	RegisterDialogCSSLink	Registers CSS file for dialogs
Protected method	RegisterDialogHandlingScripts	Registers script for centralized dialog closing. (Contains functionality for refreshing opener window.)
Public method	RegisterEscScript	Registers the script to handle the close window operation on ESC key
Public method	RegisterExportScript	Registers the object export function
Public method	RegisterModalDialogScript	Registers the model dialog script
Protected method	RegisterModalPageScripts	Register wopener script and base target tag for this page
Protected method	RegisterSplitModeSync(Boolean, Boolean)	Registers js script for synchronization scroll bars in split mode.
Protected method	RegisterSplitModeSync(Boolean, Boolean, Boolean)	Registers java script for synchronization scroll bars in split mode.
Public method	RegisterTooltipScript	Registers the tooltip script
Protected method	Render	Render event handler (Overrides Page.Render(HtmlTextWriter).)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractCMSPage.)
Public method	SetAction	Sets the particular action data.
Public method	SetBreadcrumb	Sets the particular Breadcrumb data
Public method	SetBrowserClass	Sets the browser class to the body class
Public method	SetCulture	Sets current UI culture
Public method	SetEditedObject	Set edited object and ensure redirection to frame set if necessary
Protected method	SetFormAction	Sets the form action for current page if was rewritten by URL rewriter (Inherited from AbstractCMSPage.)
Public method	SetHelp	Sets the page title
Public method	SetLiveCulture	Sets current UI culture for live site
Public method	SetLiveDialogClass	Sets the live site dialog body class.
Public method	SetLiveRTL	Sets the RTL culture for live site to the body class if RTL language
Public method	SetRTL	Sets the RTL culture to the body class if RTL language
Public method	SetTab(UITabItem)	Sets the tab.
Public method	SetTab(Int32, String, String, String)	Sets the particular tab.
Public method	SetTitle	Sets the page title
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	ShowChangesSaved	Shows the general changes saved message. (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.)
Protected method	ValidateHash	Checks if the user is global administrator (can access the administration (development) page, or a hash is valid)

Extension Methods

	Name	Description
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.)

Events

	Name	Description
Public event Static member	OnAfterPageInit	Fires after page Init
Public event Static member	OnAfterPageLoad	Fires after page Load
Public event Static member	OnAfterPagePreInit	Fires after page PreInit
Public event Static member	OnAfterPagePreRender	Fires after page PreRender
Public event Static member	OnAfterPageRender	Fires after page Render
Public event Static member	OnBeforePageInit	Fires before page Init
Public event Static member	OnBeforePageLoad	Fires before page Load
Public event Static member	OnBeforePagePreInit	Fires before page PreInit
Public event Static member	OnBeforePagePreRender	Fires before page PreRender
Public event Static member	OnBeforePageRender	Fires before page Render
Public event	OnCheckTabSecurity	Check security event.
Public event	OnTabCreated	Tab creation event.