| CMSUIPersonalizationPage Class |
Base page for the UI personalization tab of administration pages to apply global settings to the pages.
Inheritance HierarchySystemObject
System.Web.UIControl
System.Web.UITemplateControl
System.Web.UIPage
CMS.UIControlsAbstractCMSPage
CMS.UIControlsCMSPage
CMS.UIControlsCMSAdministrationPage
CMS.UIControlsCMSUIPersonalizationPage
System.Web.UIControl
System.Web.UITemplateControl
System.Web.UIPage
CMS.UIControlsAbstractCMSPage
CMS.UIControlsCMSPage
CMS.UIControlsCMSAdministrationPage
CMS.UIControlsCMSUIPersonalizationPage
Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 9.0.0
SyntaxC#
public abstract class CMSUIPersonalizationPage : CMSAdministrationPage
The CMSUIPersonalizationPage type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CMSUIPersonalizationPage |
Fields| Name | Description | |
|---|---|---|
 | mAddBaseTag |
Indicates whether base tag should be added
(Inherited from CMSPage.) |
| mBodyClass |
Generic body class - contains the base body CSS class
(Inherited from CMSPage.) |
| mContextMenuContainer |
Container control for the context menus.
(Inherited from AbstractCMSPage.) |
| mCurrentMaster |
Current master page
(Inherited from CMSPage.) |
| mCurrentSiteName |
Current site name
(Inherited from CMSPage.) |
| mCurrentUser |
Current user
(Inherited from CMSPage.) |
| mFootersContainer |
Container control for the page footers.
(Inherited from AbstractCMSPage.) |
| mHeaderActions |
Header actions
(Inherited from AbstractCMSPage.) |
| mInstallPage |
Indicates whether current page is install page
(Inherited from CMSPage.) |
| mLogsContainer |
Container control for the log controls.
(Inherited from AbstractCMSPage.) |
| mLogViewState |
Log page ViewState
(Inherited from CMSPage.) |
| mManagersContainer |
Container control for the page managers.
(Inherited from AbstractCMSPage.) |
| mPageStatusContainer |
Page status container
(Inherited from CMSPage.) |
| mRegisterWOpener |
Indicates whether wOpeber is loaded
(Inherited from CMSPage.) |
| mRelativePath |
Relative path
(Inherited from CMSPage.) |
| mScriptManagerControl |
Script manager control.
(Inherited from AbstractCMSPage.) |
Properties| Name | Description | |
|---|---|---|
 | AddBaseTag |
Gets or sets the value that indicates whether base tag with target _self should be added to the header
(Inherited from CMSPage.) |
| AfterFormPlaceHolder |
Gets placeholder located after form element.
(Inherited from AbstractCMSPage.) |
| BodyClass |
Body class
(Inherited from CMSPage.) |
| ContextMenuContainer |
Container control for the context menus.
(Inherited from AbstractCMSPage.) |
| CultureCode |
Gets culture code of current document initialized from query string.
(Inherited from AbstractCMSPage.) |
| CurrentMaster |
Current CMSMasterPage page
(Inherited from CMSPage.) |
| CurrentSiteName |
Current site name
(Inherited from CMSPage.) |
 | CurrentUser |
Current user
(Inherited from CMSPage.) |
| CurrentUseXUACompatible |
If true, X-UA-Compatible header will be added to the page.
(Inherited from AbstractCMSPage.) |
| DisableAdministrationInterface |
If true, the administration interface is disabled
(Inherited from CMSPage.) |
| DocumentID |
Gets document ID of current document initialized from query string.
(Inherited from AbstractCMSPage.) |
| DocumentManager |
Document manager control.
(Inherited from AbstractCMSPage.) |
| 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.) |
| 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.) |
| EnableContextHelp |
Tells you whether context help script generation into page is enabled.
(Inherited from AbstractCMSPage.) |
| EnsureDocumentManager |
Indicates if document manager should be ensured
(Inherited from AbstractCMSPage.) |
| EnsurePreferredCulture |
Indicates if content preferred culture should be ensured.
(Inherited from AbstractCMSPage.) |
| FooterContainer |
Container control for the page footers.
(Inherited from AbstractCMSPage.) |
| HeaderActions |
Local header actions
(Inherited from AbstractCMSPage.) |
| CheckHashValidationAttribute | (Inherited from CMSPage.) |
| IsCMSDesk |
Determines whether the current page is located under the CMS Desk.
(Inherited from AbstractCMSPage.) |
| IsDialog |
Indicates whether page is a dialog.
False by default.
(Inherited from AbstractCMSPage.) |
| IsRootDialog |
Indicates whether page is root dialog (top dialog page with header and footer)
(Inherited from AbstractCMSPage.) |
| IsStandardPage |
If true, the page is a UI page
(Inherited from AbstractCMSPage.) |
| LogsContainer |
Container control for the log controls.
(Inherited from AbstractCMSPage.) |
| ManagersContainer |
Container for the page and script managers
(Inherited from CMSPage.) |
| MessagesPlaceHolder |
Local page messages placeholder
(Inherited from AbstractCMSPage.) |
| NodeID |
Gets node ID of current document initialized from query string.
(Inherited from AbstractCMSPage.) |
| PageBreadcrumbs |
Page title
(Inherited from CMSPage.) |
| PageStatusContainer |
Page status container
(Inherited from CMSPage.) |
| PageTitle |
Page title
(Inherited from CMSPage.) |
| 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.) |
| RegisterGlobalHotKeyScript |
Gets or sets the value that indicates whether global hotkey script should be registered
(Inherited from AbstractCMSPage.) |
| RegisterPageLoadedScript |
Indicates if page loaded script should be registered.
(Inherited from CMSPage.) |
| RegisterWOpener |
If true, the page registers the wopener JavaScript variable
(Inherited from CMSPage.) |
| RelativePath |
Page relative path
(Inherited from CMSPage.) |
| RequiresDialog |
Gets or sets the value that indicates whether the page is displayed as dialog.
(Inherited from CMSPage.) |
| ScriptManagerControl |
Script manager control.
(Inherited from AbstractCMSPage.) |
| SelectedSiteID |
Returns correct selected site id for current user.
(Inherited from CMSAdministrationPage.) |
| SiteID |
Returns correct site id for current user.
(Inherited from CMSAdministrationPage.) |
| SiteName |
Returns the site name for current user, based on SiteID.
(Inherited from CMSAdministrationPage.) |
| SplitModeAllwaysRefresh |
Indicates if split mode frame should be refreshed always on post-back (even for different cultures).
(Inherited from CMSPage.) |
| TabMode |
Indicates if the page is in tab mode.
(Inherited from AbstractCMSPage.) |
| Tree |
Tree provider object.
(Inherited from AbstractCMSPage.) |
| TypeName |
Returns the object type name
(Inherited from CMSPage.) |
| UIContext |
Page's UI context
(Inherited from AbstractCMSPage.) |
| UseViewStateUserKey |
If true, ViewStateUserKey is used.
(Inherited from AbstractCMSPage.) |
Methods| Name | Description | |
|---|---|---|
 | AddConfirmation |
Adds confirmation text to existing message on the page.
(Inherited from AbstractCMSPage.) |
| AddError |
Adds error text to existing message on the page.
(Inherited from AbstractCMSPage.) |
| AddHeaderAction |
Adds specified action to the page header actions.
(Inherited from AbstractCMSPage.) |
| AddHeaderActions |
Adds the list of header actions to the page header actions.
(Inherited from AbstractCMSPage.) |
| AddInformation |
Adds information text to existing message on the page.
(Inherited from AbstractCMSPage.) |
| AddMessage |
Adds text to existing message on the page.
(Inherited from AbstractCMSPage.) |
| AddNoCacheTag |
Adds the no-cache tag to the page header
(Inherited from CMSPage.) |
| AddScript |
Adds the script to the page
(Inherited from CMSPage.) |
| AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractCMSPage.) |
| BasePage_Load |
Load event handler
(Inherited from CMSAdministrationPage.) |
| DisableDebugging |
Disables all debugging for current page
(Inherited from CMSPage.) |
| EnsureFootersControl |
Ensures the page footer control.
(Inherited from AbstractCMSPage.) |
| EnsureScriptManager |
Ensures the script manager on the page.
(Inherited from CMSPage.) |
| Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractCMSPage.) |
| EvalReturnType(String) |
Templated Eval, returns the value converted to specific type.
(Inherited from AbstractCMSPage.) |
| EvalBool |
Evaluates the item data and converts it to the bool.
(Inherited from AbstractCMSPage.) |
| EvalDateTime |
Evaluates the item data and converts it to the date time.
(Inherited from AbstractCMSPage.) |
| EvalDouble |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractCMSPage.) |
| EvalGuid |
Evaluates the item data and converts it to the guid.
(Inherited from AbstractCMSPage.) |
| EvalHTML |
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractCMSPage.) |
| EvalInteger |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractCMSPage.) |
| EvalJSString |
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractCMSPage.) |
| EvalText |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractCMSPage.) |
| GetDocumentManagerContainer |
Gets control ideal for containing document manager.
(Inherited from AbstractCMSPage.) |
| GetImageUrl |
Gets UI image URL.
(Inherited from AbstractCMSPage.) |
| GetSiteID |
Gets valid site id for current user.
(Inherited from CMSAdministrationPage.) |
| CheckAdministrationInterface |
Checks if the administration interface is enabled, if not, redirects to access denied
(Inherited from CMSPage.) |
| CheckEditor |
Checks whether the user is an editor
(Inherited from CMSPage.) |
| CheckGlobalAdministrator |
Check whether current page is displayed for specific site
and if not check whether global app is not disable for global admin
(Inherited from CMSAdministrationPage.) |
| CheckLicense |
Checks the license for the given feature. Redirects to feature not available if not available.
(Inherited from CMSPage.) |
| CheckPermissions |
Checks the security of the permissions, returns true if the security check succeeded
(Inherited from CMSPage.) |
| CheckResourceSite |
Checks the security of the resource, returns true if the module is assigned to the site
(Inherited from CMSPage.) |
| CheckSite |
Checks if current site is valid. Redirects to invalid web site if not.
(Inherited from CMSPage.) |
| CheckUIElements |
Checks the security of the UI elements, returns true if the security check succeeded
(Inherited from CMSPage.) |
| InitDebug |
Initializes the debug controls.
(Inherited from AbstractCMSPage.) |
| InitDevTools |
Initializes the Dev tools menu
(Inherited from AbstractCMSPage.) |
| InitTabs(String) |
Initializes the array for the tabs data
(Inherited from CMSPage.) |
| InitTabs(String, String, String) |
Initializes the array for the tabs data
(Inherited from CMSPage.) |
| 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.) |
| LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractCMSPage.) |
| LogAndShowError |
Logs the exception and displays a general error message
(Inherited from AbstractCMSPage.) |
| OnInit |
Init event handler
(Overrides CMSPageOnInit(EventArgs).) |
| OnLoad |
Load event handler
(Inherited from CMSPage.) |
| OnPreInit |
PreInit event handler
(Inherited from CMSPage.) |
| OnPreRender |
Page PreRender.
(Overrides CMSPageOnPreRender(EventArgs).) |
| OnPreRenderComplete |
Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered.
(Inherited from AbstractCMSPage.) |
| RaiseCheckTabSecurity |
Raises OnCheckTabSecurity event.
(Inherited from CMSPage.) |
| RaiseTabCreated |
Raises OnTabCreated event.
(Inherited from CMSPage.) |
| RegisterBodyModifyingScript |
Registers script that modified body element. (For IE7,8 compatibility reasons. See KB927917 for more information.)
(Inherited from AbstractCMSPage.) |
| 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.) |
| RegisterDialogCSSLink |
Registers CSS file for dialogs
(Inherited from CMSPage.) |
| RegisterDialogHandlingScripts |
Registers script for centralized dialog closing. (Contains functionality for refreshing opener window.)
(Inherited from CMSPage.) |
| RegisterEscScript |
Registers the script to handle the close window operation on ESC key
(Inherited from CMSPage.) |
| RegisterExportScript |
Registers the object export function
(Inherited from CMSPage.) |
| RegisterModalDialogScript |
Registers the model dialog script
(Inherited from CMSPage.) |
| RegisterModalPageScripts |
Register wopener script and base target tag for this page
(Inherited from CMSPage.) |
| RegisterSplitModeSync(Boolean, Boolean) |
Registers js script for synchronization scroll bars in split mode.
(Inherited from CMSPage.) |
| RegisterSplitModeSync(Boolean, Boolean, Boolean) |
Registers java script for synchronization scroll bars in split mode.
(Inherited from CMSPage.) |
| RegisterTooltipScript |
Registers the tooltip script
(Inherited from CMSPage.) |
| Render |
Render event handler
(Inherited from CMSPage.) |
| ResolveUrl |
Resolves the given URL
(Inherited from AbstractCMSPage.) |
| SetAction |
Sets the particular action data.
(Inherited from CMSPage.) |
| SetBreadcrumb |
Sets the particular Breadcrumb data
(Inherited from CMSPage.) |
| SetBrowserClass |
Sets the browser class to the body class
(Inherited from CMSPage.) |
| SetCulture |
Sets current UI culture
(Inherited from CMSPage.) |
| SetEditedObject |
Set edited object and ensure redirection to frame set if necessary
(Inherited from CMSPage.) |
| SetFormAction |
Sets the form action for current page if was rewritten by URL rewriter
(Inherited from AbstractCMSPage.) |
| SetHelp |
Sets the page title
(Inherited from CMSPage.) |
| SetLiveCulture |
Sets current UI culture for live site
(Inherited from CMSPage.) |
| SetLiveDialogClass |
Sets the live site dialog body class.
(Inherited from CMSPage.) |
| SetLiveRTL |
Sets the RTL culture for live site to the body class if RTL language
(Inherited from CMSPage.) |
| SetRTL |
Sets the RTL culture to the body class if RTL language
(Inherited from CMSPage.) |
| SetTab(UITabItem) |
Sets the tab.
(Inherited from CMSPage.) |
| SetTab(Int32, String, String, String) |
Sets the particular tab.
(Inherited from CMSPage.) |
| SetTitle |
Sets the page title
(Inherited from CMSPage.) |
| ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractCMSPage.) |
| ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractCMSPage.) |
| ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractCMSPage.) |
| ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractCMSPage.) |
| ShowMessage |
Shows the specified message, optionally with a tooltip text and description.
(Inherited from AbstractCMSPage.) |
| ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractCMSPage.) |
| 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 | |
|---|---|---|
 | 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.) |
| GetString |
Gets the string by the specified resource key
(Defined by ControlsExtensions.) |
| LoadUserControl |
Loads the user control based on the given path
(Defined by ControlsExtensions.) |
Events| Name | Description | |
|---|---|---|
 | OnCheckTabSecurity |
Check security event.
(Inherited from CMSPage.) |
| OnTabCreated |
Tab creation event.
(Inherited from CMSPage.) |
See Also