Click or drag to resize
CMSPortalManager Class
Portal page manager.
Inheritance Hierarchy

Namespace: CMS.PortalControls
Assembly: CMS.PortalControls (in CMS.PortalControls.dll) Version: 9.0.0
public class CMSPortalManager : CMSWebControl, 
	INamingContainer, IPageManager

The CMSPortalManager type exposes the following members.

Public methodCMSPortalManager
Protected fieldmAllPagePlaceholders
Collection of all the page placeholders.
Protected fieldmCMSEditableControls
Collection of the page editable regions.
Protected fieldmCMSPagePlaceholders
Collection of all the base level page placeholders.
Protected fieldmPlaceholderMenuControl
Page placeholder menu inner control.
Public propertyActivateZoneBorder
If true zone border can be activated (+add widget button).
Public propertyAllPagePlaceholders
Returns the collection of all the page placeholders.
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public propertyCMSEditableControls
Returns the array of the editable controls.
Public propertyCMSPagePlaceholders
Returns the collection of all the base level page placeholders.
Public propertyCurrentEditMenu
Gets the current edit menu if available
Public propertyCurrentNode
Returns currently edited document if it is available in the given context.
Public propertyCurrentObjectEditMenu
Gets the current object edit menu if available
Public propertyCurrentPageInfo
Returns currently processed page info, if it is available in the given context.
Public propertyCurrentPlaceholder
Returns the Placeholder of the current page.
Public propertyDocumentManager
Document manager
Public propertyHierarchyPageInfo
Hierarchy page info
Public propertyHighlightDropableAreas
Droppable areas are highlighted when widget dragged.
Public propertyCheckPermissions
Allows you to specify whether to check permissions of the current user. If the value is 'false' (default value) no permissions are checked. Otherwise, only nodes for which the user has read permission are displayed.
Public propertyIsAuthorized
Returns true if the user is authorized for current document.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyPageAliasPath
Current site alias path.
Public propertyPageTemplate
Gets the page template of the current page.
Public propertyPlaceholderMenuControl
Placeholder menu inner control.
Public propertyPreserveContent
Allows you to specify whether the content of non-existing or not visible regions should be preserved when the content is saved.
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertySiteName
Current site name.
Protected propertyTagKey
Generate div tag key by default due to HTML validity
(Overrides WebControlTagKey.)
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public propertyUIContext
Returns control's UI context
(Inherited from CMSWebControl.)
Public propertyUseObjectLocking
Gets a value that indicates if the object locking is used.
Public propertyViewMode
Current page mode.
Public methodClearCache
Clears the cached items on a page.
Protected methodCMSPortalManager_Init
Init event handler.
Protected methodCMSPortalManager_PreRender
PreRender event handler.
Protected methodCreateChildControls
Child control creation.
(Overrides ControlCreateChildControls.)
Public methodEnsureNotLoadedZones
Ensures the list of the zones that were not yet loaded.
Protected methodFindAllPlaceholders
Returns the list of all the page placeholders using the given alias path.
Public methodGetSpellCheckFields
Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public methodStatic memberGetTemplateInstanceForEditing
Gets the template instance for editing changes.
Public methodStatic memberIsAuthorizedPerDocument
Returns true if current user is allowed to read and modify specified node
Public methodMarkZoneLoaded
Marks the given zone as loaded.
Protected methodOnInit
Init event handler.
(Inherited from CMSWebControl.)
Public methodReloadData
Causes reloading the data, override to implement the data reloading procedure.
Protected methodRender
Render action.
(Overrides WebControlRender(HtmlTextWriter).)
Public methodStatic memberSaveTemplateChanges
Saves the changes to the widget zone.
Public methodSetMainPagePlaceholder
Sets the main (root) page placeholder.
Public methodValidate
Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
Extension Methods
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
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 MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
See Also