CMSPortalManager Class

Portal page manager.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.PortalEngine.Web.UI.CMSPortalManager

Namespace: CMS.PortalEngine.Web.UI
Assembly: CMS.PortalEngine.Web.UI (in CMS.PortalEngine.Web.UI.dll) Version: 10.0.0

Syntax

public class CMSPortalManager : CMSWebControl, 
	INamingContainer, IPageManager

The CMSPortalManager type exposes the following members.

Constructors

	Name	Description
Public method	CMSPortalManager	Constructor.

Fields

	Name	Description
Protected field	mAllPagePlaceholders	Collection of all the page placeholders.
Protected field	mCMSEditableControls	Collection of the page editable regions.
Protected field	mCMSPagePlaceholders	Collection of all the base level page placeholders.
Protected field	mPlaceholderMenuControl	Page placeholder menu inner control.

Properties

	Name	Description
Public property	ActivateZoneBorder	If true zone border can be activated (+add widget button).
Public property	AllPagePlaceholders	Returns the collection of all the page placeholders.
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public property	CMSEditableControls	Returns the array of the editable controls.
Public property	CMSPagePlaceholders	Returns the collection of all the base level page placeholders.
Public property	CurrentEditMenu	Gets the current edit menu if available
Public property	CurrentNode	Returns currently edited document if it is available in the given context.
Public property	CurrentObjectEditMenu	Gets the current object edit menu if available
Public property	CurrentPageInfo	Returns currently processed page info, if it is available in the given context.
Public property	CurrentPlaceholder	Returns the Placeholder of the current page.
Public property	DocumentManager	Document manager
Public property	HierarchyPageInfo	Hierarchy page info
Public property	HighlightDropableAreas	Droppable areas are highlighted when widget dragged.
Public property	CheckPermissions	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 property	IsAuthorized	Returns true if the user is authorized for current document.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	PageAliasPath	Current site alias path.
Public property	PageTemplate	Gets the page template of the current page.
Public property	PlaceholderMenuControl	Placeholder menu inner control.
Public property	PreserveContent	Allows you to specify whether the content of non-existing or not visible regions should be preserved when the content is saved.
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	SiteName	Current site name.
Protected property	TagKey	Generate div tag key by default due to HTML validity (Overrides WebControl.TagKey.)
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public property	UIContext	Control's UI Context
Public property	UseObjectLocking	Gets a value that indicates if the object locking is used.
Public property	ViewMode	Current page mode.

Methods

	Name	Description
Public method	ClearCache	Clears the cached items on a page.
Protected method	CMSPortalManager_Init	Init event handler.
Protected method	CMSPortalManager_PreRender	PreRender event handler.
Protected method	CreateChildControls	Child control creation. (Overrides Control.CreateChildControls().)
Public method	EnsureNotLoadedZones	Ensures the list of the zones that were not yet loaded.
Protected method	FindAllPlaceholders	Returns the list of all the page placeholders using the given alias path.
Public method	GetSpellCheckFields	Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
Public method Static member	GetTemplateInstanceForEditing	Gets the template instance for editing changes.
Public method Static member	IsAuthorizedPerDocument	Returns true if current user is allowed to read and modify specified node
Public method	MarkZoneLoaded	Marks the given zone as loaded.
Protected method	OnInit	Init event handler. (Inherited from CMSWebControl.)
Public method	ReloadData	Causes reloading the data, override to implement the data reloading procedure.
Protected method	Render	Render action. (Overrides WebControl.Render(HtmlTextWriter).)
Public method Static member	SaveTemplateChanges	Saves the changes to the widget zone.
Public method	SetMainPagePlaceholder	Sets the main (root) page placeholder.
Public method	Validate	Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	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.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)