CMSPage Class |
Namespace: CMS.UIControls
public abstract class CMSPage : AbstractCMSPage, IAdminPage
The CMSPage type exposes the following members.
Name | Description | |
---|---|---|
EXPORT_OBJECT_HEIGHT |
Height of the export object modal window
| |
EXPORT_OBJECT_WIDTH |
Width of the export object modal window
| |
mBodyClass |
Generic body class - contains the base body CSS class
|
Name | Description | |
---|---|---|
AddBaseTag |
Gets or sets the value that indicates whether base tag with target _self should be added to the header
| |
AfterFormPlaceHolder |
Gets placeholder located after form element.
(Inherited from AbstractCMSPage.) | |
BodyClass |
Body class
| |
CheckHashValidationAttribute | ||
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
| |
CurrentSiteName |
Current site name
| |
CurrentUser |
Current user
| |
CurrentUseXUACompatible |
If true, X-UA-Compatible header will be added to the page.
(Inherited from AbstractCMSPage.) | |
DisableAdministrationInterface |
If true, the administration interface is disabled
| |
DocumentID |
Gets document ID of current document initialized from query string.
(Inherited from AbstractCMSPage.) | |
DocumentManager |
Document manager control.
(Inherited from AbstractCMSPage.) | |
EditedDocument |
Document edited by the current page. If set to NULL, redirects to the information page with information that document has been deleted.
| |
EditedObject |
Object edited by the current page. If set to NULL, redirects to the information page with information that object has been deleted.
| |
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.
| |
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.) | |
FooterFrameHeight |
Height of frame with footer
| |
HeaderActions |
Local header actions
(Inherited from AbstractCMSPage.) | |
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.) | |
IsScreenLocked |
Indicates if screen is locked.
| |
IsStandardPage |
If true, the page is a UI page
(Inherited from AbstractCMSPage.) | |
LastRequest |
Time of last request (not counting ScreenLock callbacks).
| |
LogsContainer |
Container control for the log controls.
(Inherited from AbstractCMSPage.) | |
ManagersContainer |
Container for the page and script managers
(Overrides AbstractCMSPageManagersContainer.) | |
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
| |
PageStatusContainer |
Page status container
| |
PageTitle |
Page title
| |
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
| |
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.
| |
RegisterWOpener |
If true, the page registers the wopener JavaScript variable
| |
RelativePath |
Page relative path
| |
RequiresDialog |
Gets or sets the value that indicates whether the page is displayed as dialog.
| |
ScriptManagerControl |
Script manager control.
(Inherited from AbstractCMSPage.) | |
SplitModeAllwaysRefresh |
Indicates if split mode frame should be refreshed always on post-back (even for different cultures).
| |
TabMode |
Indicates if the page is in tab mode.
(Inherited from AbstractCMSPage.) | |
TabsFrameHeight |
Height of frame with tabs
| |
TabsOnlyHeight |
Height of frame containing tabs only
| |
TitleOnlyHeight |
Height of frame containing title only
| |
Tree |
Tree provider object.
(Inherited from AbstractCMSPage.) | |
TypeName |
Returns the object type name
| |
UIContext |
Page's UI context
(Inherited from AbstractCMSPage.) | |
UseViewStateUserKey |
If true, ViewStateUserKey is used.
(Inherited from AbstractCMSPage.) |
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
| |
AddScript |
Adds the script to the page
| |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractCMSPage.) | |
CheckAdministrationInterface |
Checks if the administration interface is enabled, if not, redirects to access denied
| |
CheckEditor |
Checks whether the user is an editor
| |
CheckGlobalAdministrator |
Checks whether user is global administrator with access to all applications
User without global access is redirected to access denied page.
| |
CheckLicense |
Checks the license for the given feature. Redirects to feature not available if not available.
| |
CheckPermissions |
Checks the security of the permissions, returns true if the security check succeeded
| |
CheckPreferredCulture |
Checks the preferred culture and changes it to default if not valid. Returns true if the culture was valid.
| |
CheckPreferredCulture(String) |
Checks the preferred culture and changes it to default if not valid. Returns true if the culture was valid.
| |
CheckResourceSite |
Checks the security of the resource, returns true if the module is assigned to the site
| |
CheckSite |
Checks if current site is valid. Redirects to invalid web site if not.
| |
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.
| |
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.
| |
CheckUIElementAccessHierarchicalInternal |
Checks the permissions of all UI elements hierarchically starting with specified UI element (with optional custom root element).
| |
CheckUIElements |
Checks the security of the UI elements, returns true if the security check succeeded
| |
CreateDocumentManager |
Creates a document manager for this page.
(Inherited from AbstractCMSPage.) | |
DisableDebugging |
Disables all debugging for current page
| |
EnsureFootersControl |
Ensures the page footer control.
(Inherited from AbstractCMSPage.) | |
EnsureScriptManager |
Ensures the script manager on the page.
(Overrides AbstractCMSPageEnsureScriptManager.) | |
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.) | |
EvalDecimal |
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractCMSPage.) | |
EvalDouble |
Evaluates the item data and converts it to the double.
(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.) | |
GetAccessDeniedUrl |
Gets the URL to Access denied page
| |
GetCMSDeskUIElementAccessDenied |
Gets the URL for CMS Desk Access denied page
| |
GetDocumentManagerContainer |
Gets control ideal for containing document manager.
(Inherited from AbstractCMSPage.) | |
GetImageUrl |
Gets UI image URL.
(Inherited from AbstractCMSPage.) | |
InitDebug |
Initializes the debug controls.
(Inherited from AbstractCMSPage.) | |
InitTabs(String) |
Initializes the array for the tabs data
| |
InitTabs(String, String, String) |
Initializes the array for the tabs data
| |
IsUserAuthorizedPerContent |
Determines whether current user is authorized to access cms.content
| |
IsUserAuthorizedPerContent(String) |
Determines whether current user is authorized to access cms.content
| |
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 AbstractCMSPageOnInit(EventArgs).) | |
OnLoad |
Load event handler
(Overrides ControlOnLoad(EventArgs).) | |
OnPreInit |
PreInit event handler
(Overrides AbstractCMSPageOnPreInit(EventArgs).) | |
OnPreRender |
PreRender event handler
(Overrides AbstractCMSPageOnPreRender(EventArgs).) | |
OnPreRenderComplete |
Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered.
(Inherited from AbstractCMSPage.) | |
RaiseCheckTabSecurity |
Raises OnCheckTabSecurity event.
| |
RaiseTabCreated |
Raises OnTabCreated event.
| |
RedirectToAccessDenied(String) |
Redirects the user to Access denied page
| |
RedirectToAccessDenied(String, String) |
Redirects the user to Access denied page
| |
RedirectToAccessDenied(String, String, String, String, String) |
Redirects the user to Access denied page
| |
RedirectToAccessDeniedPage |
Redirects the user to Access denied page
| |
RedirectToAccessDeniedResourceNotAvailableOnSite |
Redirect to access denied page with error text not available on site
| |
RedirectToInformation |
Redirects the user to the info page which displays specified message.
| |
RedirectToResourceNotAvailableOnSite |
Redirects the user to the access denied page with info about resource not being assigned to site.
| |
RedirectToSecured |
Redirects to secured (SSL) page if its set in settings (CMSUseSSLForAdministrationInterface key)
| |
RedirectToUIElementAccessDenied |
Redirects the user to CMS Desk Access denied page
| |
RedirectToUINotAvailable |
Redirects the user to the info page which says that the UI of the requested page is not available.
| |
RefreshParentWindow |
Refreshes the parent window
| |
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
| |
RegisterDialogHandlingScripts |
Registers script for centralized dialog closing. (Contains functionality for refreshing opener window.)
| |
RegisterEscScript |
Registers the script to handle the close window operation on ESC key
| |
RegisterExportScript |
Registers the object export function
| |
RegisterModalDialogScript |
Registers the model dialog script
| |
RegisterModalPageScripts |
Register wopener script and base target tag and resizable frameset for this page
| |
RegisterSplitModeSync(Boolean, Boolean) |
Registers js script for synchronization scroll bars in split mode.
| |
RegisterSplitModeSync(Boolean, Boolean, Boolean) |
Registers java script for synchronization scroll bars in split mode.
| |
RegisterTooltipScript |
Registers the tooltip script
| |
Render |
Render event handler
(Overrides PageRender(HtmlTextWriter).) | |
ResolveUrl |
Resolves the given URL
(Inherited from AbstractCMSPage.) | |
SetAction |
Sets the particular action data.
| |
SetBreadcrumb |
Sets the particular Breadcrumb data
| |
SetBrowserClass |
Sets the browser class to the body class
| |
SetCulture |
Sets current UI culture
| |
SetEditedObject |
Set edited object and ensure redirection to frame set if necessary
| |
SetFormAction |
Sets the form action for current page if was rewritten by URL rewriter
(Inherited from AbstractCMSPage.) | |
SetHelp |
Sets the page title
| |
SetLiveCulture |
Sets current UI culture for live site
| |
SetLiveDialogClass |
Sets the live site dialog body class.
| |
SetLiveRTL |
Sets the RTL culture for live site to the body class if RTL language
| |
SetRTL |
Sets the RTL culture to the body class if RTL language
| |
SetTab(UITabItem) |
Sets the tab.
| |
SetTab(Int32, String, String, String) |
Sets the particular tab.
| |
SetTitle |
Sets the page title
| |
ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractCMSPage.) | |
ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractCMSPage.) | |
ShowError |
Shows the specified error message, optionally with a tooltip text.
(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)
|
Name | Description | |
---|---|---|
AddToHeader |
Adds the given HTML code to the header of the page.
(Defined by PageExtensions.) | |
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.) |
Name | Description | |
---|---|---|
OnAfterPageInit |
Fires after page Init
| |
OnAfterPageLoad |
Fires after page Load
| |
OnAfterPagePreInit |
Fires after page PreInit
| |
OnAfterPagePreRender |
Fires after page PreRender
| |
OnAfterPageRender |
Fires after page Render
| |
OnBeforePageInit |
Fires before page Init
| |
OnBeforePageLoad |
Fires before page Load
| |
OnBeforePagePreInit |
Fires before page PreInit
| |
OnBeforePagePreRender |
Fires before page PreRender
| |
OnBeforePageRender |
Fires before page Render
| |
OnCheckTabSecurity |
Check security event.
| |
OnTabCreated |
Tab creation event.
|