Click or drag to resize
PortalPage Class
Base class for the portal page template.
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 9.0.0
Syntax
C#
public abstract class PortalPage : ContentPage

The PortalPage type exposes the following members.

Constructors
  NameDescription
Protected methodPortalPage
Top
Fields
  NameDescription
Protected fieldmContextMenuContainer
Container control for the context menus.
(Inherited from AbstractCMSPage.)
Protected fieldmDocumentBase
Document base.
(Inherited from ContentPage.)
Protected fieldmFootersContainer
Container control for the page footers.
(Inherited from AbstractCMSPage.)
Protected fieldmHeaderActions
Header actions
(Inherited from AbstractCMSPage.)
Protected fieldmLogsContainer
Container control for the log controls.
(Inherited from AbstractCMSPage.)
Protected fieldmManagersContainer
Container control for the page managers.
(Inherited from AbstractCMSPage.)
Protected fieldmRedirectedToSafeMode
If true, the document has been already redirected to the safe mode.
Protected fieldmScriptManagerControl
Script manager control.
(Inherited from AbstractCMSPage.)
Top
Properties
  NameDescription
Public propertyAfterFormPlaceHolder
Gets placeholder located after form element.
(Inherited from AbstractCMSPage.)
Public propertyBodyClass
Body class.
(Inherited from ContentPage.)
Public propertyBodyParameters
Body parameters.
(Inherited from ContentPage.)
Public propertyContextMenuContainer
Container control for the context menus.
(Inherited from AbstractCMSPage.)
Public propertyCssFile
Css file.
(Inherited from ContentPage.)
Public propertyCultureCode
Gets culture code of current document initialized from query string.
(Inherited from AbstractCMSPage.)
Public propertyCurrentPage
Current page info.
(Inherited from ContentPage.)
Public propertyCurrentSite
Current site.
(Inherited from ContentPage.)
Public propertyCurrentUser
Current user.
(Inherited from ContentPage.)
Public propertyCurrentUseXUACompatible
If true, X-UA-Compatible header will be added to the page.
(Inherited from AbstractCMSPage.)
Public propertyDescription
Description.
(Inherited from ContentPage.)
Public propertyDocType
DocType.
(Inherited from ContentPage.)
Public propertyDocumentBase
Document base.
(Inherited from ContentPage.)
Public propertyDocumentID
Gets document ID of current document initialized from query string.
(Inherited from AbstractCMSPage.)
Public propertyDocumentManager
Document manager control.
(Inherited from AbstractCMSPage.)
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 propertyExtendedTags
Extended tags.
(Inherited from ContentPage.)
Public propertyFooterContainer
Container control for the page footers.
(Inherited from AbstractCMSPage.)
Public propertyHeaderActions
Local header actions
(Inherited from AbstractCMSPage.)
Public propertyHeaderTags
Header tags.
(Inherited from ContentPage.)
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.)
Protected propertyIsStandardPage
If true, the page is a UI page
(Inherited from AbstractCMSPage.)
Public propertyKeyWords
Key words.
(Inherited from ContentPage.)
Public propertyLogsContainer
Container control for the log controls.
(Inherited from AbstractCMSPage.)
Public propertyManagersContainer
Container control for the page managers.
(Inherited from AbstractCMSPage.)
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 propertyPageManager
Page manager.
(Inherited from ContentPage.)
Public propertyPageTitle
Title.
(Inherited from ContentPage.)
Protected propertyRegisterGlobalHotKeyScript
Gets or sets the value that indicates whether global hotkey script should be registered
(Inherited from AbstractCMSPage.)
Public propertyScriptManagerControl
Script manager control.
(Inherited from AbstractCMSPage.)
Public propertyTabMode
Indicates if the page is in tab mode.
(Inherited from AbstractCMSPage.)
Public propertyTree
Tree provider object.
(Inherited from AbstractCMSPage.)
Public propertyUIContext
Page's UI context
(Inherited from AbstractCMSPage.)
Public propertyUseViewStateUserKey
If true, ViewStateUserKey is used.
(Inherited from AbstractCMSPage.)
Public propertyXmlNamespace
Additional XML namespace to HTML tag.
(Inherited from ContentPage.)
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 methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodEnsureFootersControl
Ensures the page footer control.
(Inherited from AbstractCMSPage.)
Public methodEnsureScriptManager
Ensures the script manager on the page.
(Inherited from ContentPage.)
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.)
Protected methodGetDocumentManagerContainer
Gets document manager container
(Inherited from ContentPage.)
Public methodGetImageUrl
Gets UI image URL.
(Inherited from AbstractCMSPage.)
Public methodInitDebug
Initializes the debug controls.
(Inherited from AbstractCMSPage.)
Public methodInitDevTools
Initializes the Dev tools menu
(Inherited from AbstractCMSPage.)
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 methodOnError
Error handler.
(Overrides TemplateControlOnError(EventArgs).)
Protected methodOnInit
Init event handler.
(Inherited from ContentPage.)
Protected methodOnLoad
Load event handler.
(Inherited from ContentPage.)
Protected methodOnPreInit
PreInit event handler.
(Inherited from ContentPage.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from ContentPage.)
Protected methodOnPreRenderComplete
Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered.
(Inherited from AbstractCMSPage.)
Protected methodOnUnload
Unload event handler.
(Inherited from ContentPage.)
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 methodRender
Render event handler.
(Inherited from ContentPage.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractCMSPage.)
Protected methodSetFormAction
Sets the form action for current page if was rewritten by URL rewriter
(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 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.)
Top
Extension Methods
  NameDescription
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
See Also