CMSDeskPage Class

Base page for the administration pages to apply global settings to the 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.CMSDeskPage
              More...

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

Syntax

public class CMSDeskPage : CMSPage

The CMSDeskPage type exposes the following members.

Constructors

	Name	Description
Public method	CMSDeskPage	Initializes a new instance of the CMSDeskPage class.

Fields

	Name	Description
Protected field	mBodyClass	Generic body class - contains the base body CSS class (Inherited from CMSPage.)

Properties

	Name	Description
Protected property	Action	Action query parameter value.
Public property	AddBaseTag	Gets or sets the value that indicates whether base tag with target _self should be added to the header (Inherited from CMSPage.)
Public property	AfterFormPlaceHolder	Gets placeholder located after form element. (Inherited from AbstractCMSPage.)
Public property	BodyClass	Body class (Inherited from CMSPage.)
Public property	CheckDocPermissions	Indicates if document permissions should be checked during page load.
Public property	CheckHashValidationAttribute	(Inherited from CMSPage.)
Public property	ContextMenuContainer	Container control for the context menus. (Inherited from AbstractCMSPage.)
Public property	CultureCode	Culture to consider as preferred. (Overrides AbstractCMSPage.CultureCode.)
Public property	CurrentMaster	Current CMSMasterPage page (Inherited from CMSPage.)
Public property	CurrentSiteName	Current site name (Inherited from CMSPage.)
Protected property	CurrentUser	Current user (Inherited from CMSPage.)
Public property	CurrentUseXUACompatible	If true, X-UA-Compatible header will be added to the page. (Inherited from AbstractCMSPage.)
Protected property	Device	Device query parameter value.
Public property	DisableAdministrationInterface	If true, the administration interface is disabled (Inherited from CMSPage.)
Public property	DocumentID	Gets document ID of current document. (Overrides AbstractCMSPage.DocumentID.)
Public property	DocumentManager	Document manager control. (Inherited from AbstractCMSPage.)
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. (Inherited from CMSPage.)
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. (Inherited from CMSPage.)
Protected property	EnableContextHelp	Tells you whether context help script generation into page is enabled. (Inherited from AbstractCMSPage.)
Protected property	EnableSplitMode	Indicates if split mode (side by side comparison) is enabled for this page. Default value is false.
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	HeaderActions	Local header actions (Inherited from AbstractCMSPage.)
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.)
Protected property	IsProductsUI	Identifies if the page is used for products UI
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	ManagersContainer	Container for the page and script managers (Inherited from CMSPage.)
Public property	MessagesPlaceHolder	Local page messages placeholder (Inherited from AbstractCMSPage.)
Protected property	Mode	Mode query parameter value.
Public property	Node	Gets current document.
Public property	NodeID	Gets node ID of current document. (Overrides AbstractCMSPage.NodeID.)
Public property	PageBreadcrumbs	Page title (Inherited from CMSPage.)
Protected property	PageStatusContainer	Page status container (Inherited from CMSPage.)
Public property	PageTitle	Page title (Inherited from CMSPage.)
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 (Inherited from CMSPage.)
Protected property	RegisterPageLoadedScript	Indicates if page loaded script should be registered. (Inherited from CMSPage.)
Protected property	RegisterSplitScrollSync	Indicates if scrollbar synchronization script is registered. Default value is true.
Public property	RegisterWOpener	If true, the page registers the wopener JavaScript variable (Inherited from CMSPage.)
Public property	RelativePath	Page relative path (Inherited from CMSPage.)
Public property	RequiresDialog	Gets or sets the value that indicates whether the page is displayed as dialog. (Inherited from CMSPage.)
Public property	RequireSite	If true, current site is required.
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). (Inherited from CMSPage.)
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	TypeName	Returns the object type name (Inherited from CMSPage.)
Public property	UIContext	Page's UI context (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	AddMenuButtonSelectScript(String, String, String)	Adds script for selecting of ecommerce menu button.
Public method Static member	AddMenuButtonSelectScript(Control, String, String, String)	Adds script for selecting of unimenu button to given Control (probably Page).
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 (Inherited from CMSPage.)
Public method	AddScript	Adds the script to the page (Inherited from CMSPage.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractCMSPage.)
Protected method	BasePage_Load	PageLoad event handler
Public method	CheckAdministrationInterface	Checks if the administration interface is enabled, if not, redirects to access denied (Inherited from CMSPage.)
Protected method	CheckDocumentPermissions()	Checks document permissions regarding the document manager mode and optionally redirects to access denied page
Protected method	CheckDocumentPermissions(PermissionsEnum)	Checks currently edited document permissions and optionally redirects to access denied page
Public method	CheckEditor	Checks whether the user is an editor (Inherited from CMSPage.)
Public method	CheckGlobalAdministrator	Checks whether user is global administrator with access to all applications User without global access is redirected to access denied page. (Inherited from CMSPage.)
Public method	CheckLicense	Checks the license for the given feature. Redirects to feature not available if not available. (Inherited from CMSPage.)
Public method	CheckPermissions	Checks the security of the permissions, returns true if the security check succeeded (Inherited from CMSPage.)
Public method	CheckResourceSite	Checks the security of the resource, returns true if the module is assigned to the site (Inherited from CMSPage.)
Public method	CheckSite	Checks if current site is valid. Redirects to invalid web site if not. (Inherited from CMSPage.)
Public method	CheckUIElements	Checks the security of the UI elements, returns true if the security check succeeded (Inherited from CMSPage.)
Protected method	CMSDeskPage_Init	Handles the Init event of the CMSDeskPage control.
Protected method	CreateDocumentManager	Creates a document manager for this page. (Inherited from AbstractCMSPage.)
Public method	DisableDebugging	Disables all debugging for current page (Inherited from CMSPage.)
Protected method	EnsureDocumentBreadcrumbs	Ensures current document breadcrumbs (non-clickable)
Public method	EnsureFootersControl	Ensures the page footer control. (Inherited from AbstractCMSPage.)
Public method	EnsureScriptManager	Ensures the script manager on the page. (Inherited from CMSPage.)
Protected method	EnsureSplitMode	Ensures split mode.
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 control ideal for containing document manager. (Inherited from AbstractCMSPage.)
Public method	GetImageUrl	Gets UI image URL. (Inherited from AbstractCMSPage.)
Public method	InitTabs(String)	Initializes the array for the tabs data (Inherited from CMSPage.)
Public method	InitTabs(String, String, String)	Initializes the array for the tabs data (Inherited from CMSPage.)
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 CMSPage.)
Protected method	OnLoad	Load event handler (Inherited from CMSPage.)
Protected method	OnPreInit	PreInit event handler (Inherited from CMSPage.)
Protected method	OnPreRender	PreRender event handler (Inherited from CMSPage.)
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. (Inherited from CMSPage.)
Public method	RaiseTabCreated	Raises OnTabCreated event. (Inherited from CMSPage.)
Protected method	RedirectToNewCultureVersionPage	Redirects to new document language version page.
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	RegisterCookiePolicyDetection	Registers client scripts that display a message in case when the browser prevents iframe pages from setting cookies. The message informs user that the previewed page may not work properly as e.g. form submission requires CSRF token saved in cookie.
Public method	RegisterDialogCSSLink	Registers CSS file for dialogs (Inherited from CMSPage.)
Protected method	RegisterDialogHandlingScripts	Registers script for centralized dialog closing. (Contains functionality for refreshing opener window.) (Inherited from CMSPage.)
Public method	RegisterEscScript	Registers the script to handle the close window operation on ESC key (Inherited from CMSPage.)
Public method	RegisterExportScript	Registers the object export function (Inherited from CMSPage.)
Public method	RegisterModalDialogScript	Registers the model dialog script (Inherited from CMSPage.)
Protected method	RegisterModalPageScripts	Register wopener script and base target tag and resizable frameset for this page (Inherited from CMSPage.)
Protected method	RegisterSplitModeSync(Boolean, Boolean)	Registers js script for synchronization scroll bars in split mode. (Inherited from CMSPage.)
Protected method	RegisterSplitModeSync(Boolean, Boolean, Boolean)	Registers java script for synchronization scroll bars in split mode. (Inherited from CMSPage.)
Public method	RegisterTooltipScript	Registers the tooltip script (Inherited from CMSPage.)
Protected method	Render	Render event handler (Inherited from CMSPage.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractCMSPage.)
Public method	SetAction	Sets the particular action data. (Inherited from CMSPage.)
Public method	SetBreadcrumb	Sets the particular Breadcrumb data (Inherited from CMSPage.)
Public method	SetBrowserClass	Sets the browser class to the body class (Inherited from CMSPage.)
Protected method	SetCulture	Sets current UI culture (Inherited from CMSPage.)
Public method	SetEditedObject	Set edited object and ensure redirection to frame set if necessary (Inherited from CMSPage.)
Public method	SetHelp	Sets the page title (Inherited from CMSPage.)
Public method	SetRTL	Sets the RTL culture to the body class if RTL language (Inherited from CMSPage.)
Public method	SetTab(UITabItem)	Sets the tab. (Inherited from CMSPage.)
Public method	SetTab(Int32, String, String, String)	Sets the particular tab. (Inherited from CMSPage.)
Public method	SetTitle	Sets the page title (Inherited from CMSPage.)
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.)
Protected method	ValidateHash	Checks if the user is global administrator (can access the administration (development) page, or a hash is valid) (Inherited from CMSPage.)

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

Events

	Name	Description
Public event	OnCheckTabSecurity	Check security event. (Inherited from CMSPage.)
Public event	OnTabCreated	Tab creation event. (Inherited from CMSPage.)