Click or drag to resize
CMSPage Class
Base page for all CMS administration UI pages
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23
Syntax
C#
public abstract class CMSPage : AbstractCMSPage, 
	IAdminPage

The CMSPage type exposes the following members.

Constructors
  NameDescription
Protected methodCMSPage
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 methodAddMessage
Adds text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddNoCacheTag
Adds the no-cache tag to the page header
Public methodAddScript
Adds the script to the page
Public methodAddWAIRequiredTags
Adds additional tags to the page header to make page WAI valid
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodDisableDebugging
Disables all debugging for current page
Public methodEnsureFootersControl
Ensures the page footer control.
(Inherited from AbstractCMSPage.)
Public methodEnsureScriptManager
Ensures the script manager on the page.
(Overrides AbstractCMSPageEnsureScriptManager.)
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 methodEvalDouble
Evaluates the item data and converts it to the integer.
(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.)
Public methodStatic memberGetAccessDeniedUrl
Gets the URL to Access denied page
Public methodStatic memberGetCMSDeskUIElementAccessDenied
Gets the URL for CMS Desk Access denied page
Protected methodGetDocumentManagerContainer
Gets control ideal for containing document manager.
(Inherited from AbstractCMSPage.)
Public methodGetImageUrl
Gets UI image URL.
(Inherited from AbstractCMSPage.)
Public methodGetObjectIconUrl Obsolete.
Gets the icon for the given object type.
(Inherited from AbstractCMSPage.)
Public methodCheckAccessToSiteManager Obsolete.
Checks whether user is global administrator with access to all applications If it is user is redirected to access denied page.
Public methodCheckAdministrationInterface
Checks if the administration interface is enabled, if not, redirects to access denied
Public methodCheckEditor
Checks whether the user is an editor
Public methodCheckGlobalAdministrator
Checks whether user is global administrator with access to all applications User without global access is redirected to access denied page.
Public methodCheckLicense
Checks the license for the given feature. Redirects to feature not available if not available.
Public methodCheckPermissions
Checks the security of the permissions, returns true if the security check succeeded
Public methodStatic memberCheckPreferredCulture
Checks the preferred culture and changes it to default if not valid. Returns true if the culture was valid.
Public methodStatic memberCheckPreferredCulture(String)
Checks the preferred culture and changes it to default if not valid. Returns true if the culture was valid.
Public methodCheckResourceSite
Checks the security of the resource, returns true if the module is assigned to the site
Public methodCheckSite
Checks if current site is valid. Redirects to invalid web site if not.
Public methodStatic memberCheckUIElementAccessHierarchical(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 methodStatic memberCheckUIElementAccessHierarchical(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 methodCheckUIElements
Checks the security of the UI elements, returns true if the security check succeeded
Public methodInitDebug
Initializes the debug controls.
(Inherited from AbstractCMSPage.)
Public methodInitDevTools
Initializes the Dev tools menu
(Inherited from AbstractCMSPage.)
Public methodInitTabs(String)
Initializes the array for the tabs data
Public methodInitTabs(String, String, String)
Initializes the array for the tabs data
Public methodStatic memberIsUserAuthorizedPerContent
Determines whether current user is authorized to access cms.content
Public methodStatic memberIsUserAuthorizedPerContent(String)
Determines whether current user is authorized to access cms.content
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
(Overrides AbstractCMSPageOnInit(EventArgs).)
Protected methodOnLoad
Load event handler
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnPreInit
PreInit event handler
(Overrides AbstractCMSPageOnPreInit(EventArgs).)
Protected methodOnPreRender
PreRender event handler
(Overrides AbstractCMSPageOnPreRender(EventArgs).)
Protected methodOnPreRenderComplete
Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered.
(Inherited from AbstractCMSPage.)
Public methodRaiseCheckTabSecurity
Raises OnCheckTabSecurity event.
Public methodRaiseTabCreated
Raises OnTabCreated event.
Public methodStatic memberRedirectToAccessDenied(String)
Redirects the user to Access denied page
Public methodStatic memberRedirectToAccessDenied(String, String)
Redirects the user to Access denied page
Protected methodStatic memberRedirectToAccessDenied(String, String, String, String, String)
Redirects the user to Access denied page
Protected methodStatic memberRedirectToAccessDeniedPage
Redirects the user to Access denied page
Public methodStatic memberRedirectToAccessDeniedResourceNotAvailableOnSite
Redirect to access denied page with error text not available on site
Public methodStatic memberRedirectToInformation
Redirects the user to the info page which displays specified message.
Public methodStatic memberRedirectToResourceNotAvailableOnSite
Redirects the user to the access denied page with info about resource not being assigned to site.
Public methodStatic memberRedirectToSecured
Redirects to secured (SSL) page if its set in settings (CMSUseSSLForAdministrationInterface key)
Public methodStatic memberRedirectToUIElementAccessDenied
Redirects the user to CMS Desk Access denied page
Public methodStatic memberRedirectToUINotAvailable
Redirects the user to the info page which says that the UI of the requested page is not available.
Public methodStatic memberRefreshParentWindow
Refreshes the parent window
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.)
Public methodRegisterDialogCSSLink
Registers CSS file for dialogs
Protected methodRegisterDialogHandlingScripts
Registers script for centralized dialog closing. (Contains functionality for refreshing opener window.)
Public methodRegisterEscScript
Registers the script to handle the close window operation on ESC key
Public methodRegisterExportScript
Registers the object export function
Public methodRegisterModalDialogScript
Registers the model dialog script
Protected methodRegisterModalPageScripts
Register wopener script and base target tag for this page
Protected methodRegisterSplitModeSync(Boolean, Boolean)
Registers js script for synchronization scroll bars in split mode.
Protected methodRegisterSplitModeSync(Boolean, Boolean, Boolean)
Registers java script for synchronization scroll bars in split mode.
Public methodRegisterTooltipScript
Registers the tooltip script
Protected methodRender
Render event handler
(Overrides PageRender(HtmlTextWriter).)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractCMSPage.)
Public methodSetAction
Sets the particular action data.
Public methodSetBreadcrumb
Sets the particular Breadcrumb data
Public methodSetBrowserClass
Sets the browser class to the body class
Public methodSetCulture
Sets current UI culture
Public methodSetEditedObject
Set edited object and ensure redirection to frame set if necessary
Protected methodSetFormAction
Sets the form action for current page if was rewritten by URL rewriter
(Inherited from AbstractCMSPage.)
Public methodSetHelp
Sets the page title
Public methodSetLiveCulture
Sets current UI culture for live site
Public methodSetLiveDialogClass
Sets the live site dialog body class.
Public methodSetLiveRTL
Sets the RTL culture for live site to the body class if RTL language
Public methodSetRTL
Sets the RTL culture to the body class if RTL language
Public methodSetTab(UITabItem)
Sets the tab.
Public methodSetTab(Int32, String, String, String)
Sets the particular tab.
Public methodSetTitle
Sets the page title
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 methodShowChangesSaved
Shows the general changes saved message.
(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)
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodLoadUserControl
Loads the user control based on the given path
(Defined by ControlsExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Public fieldStatic memberEXPORT_OBJECT_HEIGHT
Height of the export object modal window
Public fieldStatic memberEXPORT_OBJECT_WIDTH
Width of the export object modal window
Protected fieldmAddBaseTag
Indicates whether base tag should be added
Protected fieldmBodyClass
Generic body class - contains the base body CSS class
Protected fieldmContextMenuContainer
Container control for the context menus.
(Inherited from AbstractCMSPage.)
Protected fieldmCurrentMaster
Current master page
Protected fieldmCurrentSiteName
Current site name
Protected fieldmCurrentUser
Current user
Protected fieldmDocumentManager
Document manager control.
(Inherited from AbstractCMSPage.)
Protected fieldmFootersContainer
Container control for the page footers.
(Inherited from AbstractCMSPage.)
Protected fieldmHeaderActions
Header actions
(Inherited from AbstractCMSPage.)
Protected fieldmInstallPage
Indicates whether current page is install page
Protected fieldmLogsContainer
Container control for the log controls.
(Inherited from AbstractCMSPage.)
Protected fieldmLogViewState
Log page ViewState
Protected fieldmManagersContainer
Container control for the page managers.
(Inherited from AbstractCMSPage.)
Protected fieldmPageStatusContainer
Page status container
Protected fieldmRegisterWOpener
Indicates whether wOpeber is loaded
Protected fieldmRelativePath
Relative path
Protected fieldmScriptManagerControl
Script manager control.
(Inherited from AbstractCMSPage.)
Top
Properties
  NameDescription
Public propertyAddBaseTag
Gets or sets the value that indicates whether base tag with target _self should be added to the header
Public propertyAfterFormPlaceHolder
Gets placeholder located after form element.
(Inherited from AbstractCMSPage.)
Public propertyBodyClass
Body class
Public propertyContextMenuContainer
Container control for the context menus.
(Inherited from AbstractCMSPage.)
Public propertyCultureCode
Gets culture code of current document initialized from query string.
(Inherited from AbstractCMSPage.)
Public propertyCurrentMaster
Current CMSMasterPage page
Public propertyCurrentSiteName
Current site name
Protected propertyCurrentUser
Current user
Public propertyCurrentUseXUACompatible
If true, X-UA-Compatible header will be added to the page.
(Inherited from AbstractCMSPage.)
Public propertyDisableAdministrationInterface
If true, the administration interface is disabled
Public propertyDocumentID
Gets document ID of current document initialized from query string.
(Inherited from AbstractCMSPage.)
Public propertyDocumentManager
Document manager control.
(Inherited from AbstractCMSPage.)
Public propertyStatic memberEditedDocument
Document edited by the current page. If set to NULL, redirects to the information page with information that document has been deleted.
Public propertyEditedObject
Object edited by the current page. If set to NULL, redirects to the information page with information that object has been deleted.
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.
Protected propertyEnableContextHelp
Tells you whether context help script generation into page is enabled.
(Inherited from AbstractCMSPage.)
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 propertyStatic memberFooterFrameHeight
Height of frame with footer
Public propertyHeaderActions
Local header actions
(Inherited from AbstractCMSPage.)
Public propertyCheckHashValidationAttribute
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.)
Public propertyIsRootDialog
Indicates whether page is root dialog (top dialog page with header and footer)
(Inherited from AbstractCMSPage.)
Public propertyStatic memberIsScreenLocked
Indicates if screen is locked.
Protected propertyIsStandardPage
If true, the page is a UI page
(Inherited from AbstractCMSPage.)
Public propertyStatic memberLastRequest
Time of last request (not counting ScreenLock callbacks).
Public propertyLogsContainer
Container control for the log controls.
(Inherited from AbstractCMSPage.)
Public propertyManagersContainer
Container for the page and script managers
(Overrides AbstractCMSPageManagersContainer.)
Public propertyMessagesPlaceHolder
Local page messages placeholder
(Inherited from AbstractCMSPage.)
Public propertyNodeID
Gets node ID of current document initialized from query string.
(Inherited from AbstractCMSPage.)
Public propertyPageBreadcrumbs
Page title
Protected propertyPageStatusContainer
Page status container
Public propertyPageTitle
Page title
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
Protected propertyRegisterGlobalHotKeyScript
Gets or sets the value that indicates whether global hotkey script should be registered
(Inherited from AbstractCMSPage.)
Protected propertyRegisterPageLoadedScript
Indicates if page loaded script should be registered.
Public propertyRegisterWOpener
If true, the page registers the wopener JavaScript variable
Public propertyRelativePath
Page relative path
Public propertyRequiresDialog
Gets or sets the value that indicates whether the page is displayed as dialog.
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).
Public propertyTabMode
Indicates if the page is in tab mode.
(Inherited from AbstractCMSPage.)
Public propertyStatic memberTabsFrameHeight
Height of frame with tabs
Public propertyStatic memberTabsOnlyHeight
Height of frame containing tabs only
Public propertyStatic memberTitleOnlyHeight
Height of frame containing title only
Public propertyTree
Tree provider object.
(Inherited from AbstractCMSPage.)
Public propertyTypeName
Returns the object type name
Public propertyUIContext
Page's UI context
(Inherited from AbstractCMSPage.)
Public propertyUseViewStateUserKey
If true, ViewStateUserKey is used.
(Inherited from AbstractCMSPage.)
Top
Events
  NameDescription
Public eventStatic memberOnAfterPageInit
Fires after page Init
Public eventStatic memberOnAfterPageLoad
Fires after page Load
Public eventStatic memberOnAfterPagePreInit
Fires after page PreInit
Public eventStatic memberOnAfterPagePreRender
Fires after page PreRender
Public eventStatic memberOnAfterPageRender
Fires after page Render
Public eventStatic memberOnBeforePageInit
Fires before page Init
Public eventStatic memberOnBeforePageLoad
Fires before page Load
Public eventStatic memberOnBeforePagePreInit
Fires before page PreInit
Public eventStatic memberOnBeforePagePreRender
Fires before page PreRender
Public eventStatic memberOnBeforePageRender
Fires before page Render
Public eventOnCheckTabSecurity
Check security event.
Public eventOnTabCreated
Tab creation event.
Top
See Also
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIPage
        CMS.UIControlsAbstractCMSPage
          CMS.UIControlsCMSPage
            CMS.UIControlsCMSAdministrationPage
            CMS.UIControlsCMSDeskPage
            CMS.UIControlsCMSObjectVersioningPage
            CMS.UIControlsCMSUIPage
            CMS.UIControlsCMSWorkflowPage
            CMS.UIControlsControlsExamplesPage
            CMS.UIControlsGlobalAdminPage
            CMS.UIControlsLivePage
            CMS.UIControlsMessagePage