Click or drag to resize
CMSDeskPage Class
Base page for the administration pages to apply global settings to the pages.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIPage
        CMS.UIControlsAbstractCMSPage
          CMS.UIControlsCMSPage
            CMS.UIControlsCMSDeskPage
              More...

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 13.0.131
Syntax
C#
public class CMSDeskPage : CMSPage

The CMSDeskPage type exposes the following members.

Constructors
  NameDescription
Public methodCMSDeskPage
Initializes a new instance of the CMSDeskPage class.
Top
Fields
  NameDescription
Protected fieldmBodyClass
Generic body class - contains the base body CSS class
(Inherited from CMSPage.)
Top
Properties
  NameDescription
Protected propertyAction
Action query parameter value.
Public propertyAddBaseTag
Gets or sets the value that indicates whether base tag with target _self should be added to the header
(Inherited from CMSPage.)
Public propertyAfterFormPlaceHolder
Gets placeholder located after form element.
(Inherited from AbstractCMSPage.)
Public propertyBodyClass
Body class
(Inherited from CMSPage.)
Public propertyCheckDocPermissions
Indicates if document permissions should be checked during page load.
Public propertyCheckHashValidationAttribute
(Inherited from CMSPage.)
Public propertyContextMenuContainer
Container control for the context menus.
(Inherited from AbstractCMSPage.)
Public propertyCultureCode
Culture to consider as preferred.
(Overrides AbstractCMSPageCultureCode.)
Public propertyCurrentMaster
Current CMSMasterPage page
(Inherited from CMSPage.)
Public propertyCurrentSiteName
Current site name
(Inherited from CMSPage.)
Protected propertyCurrentUser
Current user
(Inherited from CMSPage.)
Public propertyCurrentUseXUACompatible
If true, X-UA-Compatible header will be added to the page.
(Inherited from AbstractCMSPage.)
Protected propertyDevice
Device query parameter value.
Public propertyDisableAdministrationInterface
If true, the administration interface is disabled
(Inherited from CMSPage.)
Public propertyDocumentID
Gets document ID of current document.
(Overrides AbstractCMSPageDocumentID.)
Public propertyDocumentManager
Document manager control.
(Inherited from AbstractCMSPage.)
Public propertyEditedObject
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 propertyEditedObjectParent
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 propertyEnableContextHelp
Tells you whether context help script generation into page is enabled.
(Inherited from AbstractCMSPage.)
Protected propertyEnableSplitMode
Indicates if split mode (side by side comparison) is enabled for this page. Default value is false.
Protected propertyEnsureDocumentManager
Indicates if document manager should be ensured
(Inherited from AbstractCMSPage.)
Public propertyEnsurePreferredCulture
Indicates if content preferred culture should be ensured.
(Inherited from AbstractCMSPage.)
Public propertyFooterContainer
Container control for the page footers.
(Inherited from AbstractCMSPage.)
Public propertyHeaderActions
Local header actions
(Inherited from AbstractCMSPage.)
Public propertyIsCMSDesk
Determines whether the current page is located under the CMS Desk.
(Inherited from AbstractCMSPage.)
Public propertyIsDialog
Indicates whether page is a dialog. False by default.
(Inherited from AbstractCMSPage.)
Protected propertyIsProductsUI
Identifies if the page is used for products UI
Public propertyIsRootDialog
Indicates whether page is root dialog (top dialog page with header and footer)
(Inherited from AbstractCMSPage.)
Protected propertyIsStandardPage
If true, the page is a UI page
(Inherited from AbstractCMSPage.)
Public propertyManagersContainer
Container for the page and script managers
(Inherited from CMSPage.)
Public propertyMessagesPlaceHolder
Local page messages placeholder
(Inherited from AbstractCMSPage.)
Protected propertyMode
Mode query parameter value.
Public propertyNode
Gets current document.
Public propertyNodeID
Gets node ID of current document.
(Overrides AbstractCMSPageNodeID.)
Public propertyPageBreadcrumbs
Page title
(Inherited from CMSPage.)
Protected propertyPageStatusContainer
Page status container
(Inherited from CMSPage.)
Public propertyPageTitle
Page title
(Inherited from CMSPage.)
Public propertyPersistentEditedObject
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 propertyRegisterPageLoadedScript
Indicates if page loaded script should be registered.
(Inherited from CMSPage.)
Protected propertyRegisterSplitScrollSync
Indicates if scrollbar synchronization script is registered. Default value is true.
Public propertyRegisterWOpener
If true, the page registers the wopener JavaScript variable
(Inherited from CMSPage.)
Public propertyRelativePath
Page relative path
(Inherited from CMSPage.)
Public propertyRequiresDialog
Gets or sets the value that indicates whether the page is displayed as dialog.
(Inherited from CMSPage.)
Public propertyRequireSite
If true, current site is required.
Public propertyScriptManagerControl
Script manager control.
(Inherited from AbstractCMSPage.)
Protected propertySplitModeAllwaysRefresh
Indicates if split mode frame should be refreshed always on post-back (even for different cultures).
(Inherited from CMSPage.)
Public propertyTabMode
Indicates if the page is in tab mode.
(Inherited from AbstractCMSPage.)
Public propertyTree
Tree provider object.
(Inherited from AbstractCMSPage.)
Public propertyTypeName
Returns the object type name
(Inherited from CMSPage.)
Public propertyUIContext
Page's UI context
(Inherited from AbstractCMSPage.)
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractCMSPage.)
Public methodAddHeaderActions
Adds the list of header actions to the page header actions.
(Inherited from AbstractCMSPage.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddMenuButtonSelectScript(String, String, String)
Adds script for selecting of ecommerce menu button.
Public methodStatic memberAddMenuButtonSelectScript(Control, String, String, String)
Adds script for selecting of unimenu button to given Control (probably Page).
Public methodAddMessage
Adds text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddNoCacheTag
Adds the no-cache tag to the page header
(Inherited from CMSPage.)
Public methodAddScript
Adds the script to the page
(Inherited from CMSPage.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractCMSPage.)
Protected methodBasePage_Load
PageLoad event handler
Public methodCheckAdministrationInterface
Checks if the administration interface is enabled, if not, redirects to access denied
(Inherited from CMSPage.)
Protected methodCheckDocumentPermissions
Checks document permissions regarding the document manager mode and optionally redirects to access denied page
Protected methodCheckDocumentPermissions(PermissionsEnum)
Checks currently edited document permissions and optionally redirects to access denied page
Public methodCheckEditor
Checks whether the user is an editor
(Inherited from CMSPage.)
Public methodCheckGlobalAdministrator
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 methodCheckLicense
Checks the license for the given feature. Redirects to feature not available if not available.
(Inherited from CMSPage.)
Public methodCheckPermissions
Checks the security of the permissions, returns true if the security check succeeded
(Inherited from CMSPage.)
Public methodCheckResourceSite
Checks the security of the resource, returns true if the module is assigned to the site
(Inherited from CMSPage.)
Public methodCheckSite
Checks if current site is valid. Redirects to invalid web site if not.
(Inherited from CMSPage.)
Public methodCheckUIElements
Checks the security of the UI elements, returns true if the security check succeeded
(Inherited from CMSPage.)
Protected methodCMSDeskPage_Init
Handles the Init event of the CMSDeskPage control.
Protected methodCreateDocumentManager
Creates a document manager for this page.
(Inherited from AbstractCMSPage.)
Public methodDisableDebugging
Disables all debugging for current page
(Inherited from CMSPage.)
Protected methodEnsureDocumentBreadcrumbs
Ensures current document breadcrumbs (non-clickable)
Public methodEnsureFootersControl
Ensures the page footer control.
(Inherited from AbstractCMSPage.)
Public methodEnsureScriptManager
Ensures the script manager on the page.
(Inherited from CMSPage.)
Protected methodEnsureSplitMode
Ensures split mode.
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractCMSPage.)
Public methodEvalReturnType(String)
Templated Eval, returns the value converted to specific type.
(Inherited from AbstractCMSPage.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractCMSPage.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractCMSPage.)
Public methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractCMSPage.)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(Inherited from AbstractCMSPage.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractCMSPage.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractCMSPage.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractCMSPage.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractCMSPage.)
Public methodEvalText
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractCMSPage.)
Protected methodGetDocumentManagerContainer
Gets control ideal for containing document manager.
(Inherited from AbstractCMSPage.)
Public methodGetImageUrl
Gets UI image URL.
(Inherited from AbstractCMSPage.)
Public methodInitTabs(String)
Initializes the array for the tabs data
(Inherited from CMSPage.)
Public methodInitTabs(String, String, String)
Initializes the array for the tabs data
(Inherited from CMSPage.)
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.
(Inherited from AbstractCMSPage.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractCMSPage.)
Public methodLogAndShowError
Logs the exception and displays a general error message
(Inherited from AbstractCMSPage.)
Protected methodOnInit
Init event handler
(Inherited from CMSPage.)
Protected methodOnLoad
Load event handler
(Inherited from CMSPage.)
Protected methodOnPreInit
PreInit event handler
(Inherited from CMSPage.)
Protected methodOnPreRender
PreRender event handler
(Inherited from CMSPage.)
Protected methodOnPreRenderComplete
Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered.
(Inherited from AbstractCMSPage.)
Public methodRaiseCheckTabSecurity
Raises OnCheckTabSecurity event.
(Inherited from CMSPage.)
Public methodRaiseTabCreated
Raises OnTabCreated event.
(Inherited from CMSPage.)
Protected methodRedirectToNewCultureVersionPage
Redirects to new document language version page.
Public methodRegisterBodyModifyingScript
Registers script that modified body element. (For IE7,8 compatibility reasons. See KB927917 for more information.)
(Inherited from AbstractCMSPage.)
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).
(Inherited from AbstractCMSPage.)
Protected methodRegisterCookiePolicyDetection
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 methodRegisterDialogCSSLink
Registers CSS file for dialogs
(Inherited from CMSPage.)
Protected methodRegisterDialogHandlingScripts
Registers script for centralized dialog closing. (Contains functionality for refreshing opener window.)
(Inherited from CMSPage.)
Public methodRegisterEscScript
Registers the script to handle the close window operation on ESC key
(Inherited from CMSPage.)
Public methodRegisterExportScript
Registers the object export function
(Inherited from CMSPage.)
Public methodRegisterModalDialogScript
Registers the model dialog script
(Inherited from CMSPage.)
Protected methodRegisterModalPageScripts
Register wopener script and base target tag and resizable frameset for this page
(Inherited from CMSPage.)
Protected methodRegisterSplitModeSync(Boolean, Boolean)
Registers js script for synchronization scroll bars in split mode.
(Inherited from CMSPage.)
Protected methodRegisterSplitModeSync(Boolean, Boolean, Boolean)
Registers java script for synchronization scroll bars in split mode.
(Inherited from CMSPage.)
Public methodRegisterTooltipScript
Registers the tooltip script
(Inherited from CMSPage.)
Protected methodRender
Render event handler
(Inherited from CMSPage.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractCMSPage.)
Public methodSetAction
Sets the particular action data.
(Inherited from CMSPage.)
Public methodSetBreadcrumb
Sets the particular Breadcrumb data
(Inherited from CMSPage.)
Public methodSetBrowserClass
Sets the browser class to the body class
(Inherited from CMSPage.)
Protected methodSetCulture
Sets current UI culture
(Inherited from CMSPage.)
Public methodSetEditedObject
Set edited object and ensure redirection to frame set if necessary
(Inherited from CMSPage.)
Public methodSetHelp
Sets the page title
(Inherited from CMSPage.)
Public methodSetRTL
Sets the RTL culture to the body class if RTL language
(Inherited from CMSPage.)
Public methodSetTab(UITabItem)
Sets the tab.
(Inherited from CMSPage.)
Public methodSetTab(Int32, String, String, String)
Sets the particular tab.
(Inherited from CMSPage.)
Public methodSetTitle
Sets the page title
(Inherited from CMSPage.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractCMSPage.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractCMSPage.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractCMSPage.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractCMSPage.)
Public methodShowMessage
Shows the specified message, optionally with a tooltip text and description.
(Inherited from AbstractCMSPage.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractCMSPage.)
Protected methodValidateHash
Checks if the user is global administrator (can access the administration (development) page, or a hash is valid)
(Inherited from CMSPage.)
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
Events
  NameDescription
Public eventOnCheckTabSecurity
Check security event.
(Inherited from CMSPage.)
Public eventOnTabCreated
Tab creation event.
(Inherited from CMSPage.)
Top
See Also
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIPage
        CMS.UIControlsAbstractCMSPage
          CMS.UIControlsCMSPage
            CMS.UIControlsCMSDeskPage
              CMS.ContactManagement.Web.UICMSAutomationPage
              CMS.ContactManagement.Web.UICMSContactManagementPage
              CMS.ContactManagement.Web.UICMSScorePage
              CMS.Ecommerce.Web.UICMSEcommercePage
              CMS.MediaLibrary.Web.UICMSMediaLibraryPage
              CMS.Newsletters.Web.UICMSNewsletterDialog
              CMS.Newsletters.Web.UICMSNewsletterPage
              CMS.OnlineForms.Web.UICMSBizFormPage
              CMS.OnlineMarketing.Web.UICMSABTestPage
              CMS.Reporting.Web.UICMSEcommerceReportsPage
              CMS.Reporting.Web.UICMSReportingPage
              CMS.Synchronization.Web.UICMSStagingPage
              CMS.TranslationServices.Web.UICMSTranslationServicePage
              CMS.UIControlsCMSContentManagementPage
              CMS.UIControlsCMSContentPage
              CMS.UIControlsCMSCustomTablesToolsPage
              CMS.UIControlsCMSModalPage
              CMS.UIControlsCMSWidgetPropertiesPage
              CMS.UIControlsEmailQueuePage
              CMS.WebAnalytics.Web.UICMSCampaignPage
              CMS.WebAnalytics.Web.UICMSWebAnalyticsPage