PortalHelper Class

Portal control functions.

Inheritance Hierarchy

System.Object
  CMS.PortalEngine.Web.UI.PortalHelper

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

Syntax

public static class PortalHelper

The PortalHelper type exposes the following members.

Properties

	Name	Description
Public property Static member	DefaultPageLayoutIconClass	Gets the default web part font icon CSS class.
Public property Static member	DefaultPageTemplateIconClass	Gets the default web part font icon CSS class.
Public property Static member	DefaultWebPartIconClass	Gets the default web part font icon CSS class.
Public property Static member	DefaultWidgetIconClass	Gets the default widget font icon CSS class.
Public property Static member	DeviceProfileActive	Determines whether any device profile is being used at the moment and its dimensions are valid.
Public property Static member	DisplayContentInDesignMode	If true, web part content should be displayed in design mode.
Public property Static member	DisplayContentInUIElementDesignMode	If true, web part content should be displayed in UI element design mode.
Public property Static member	OnSiteEditRelativeURL	Gets or sets the on-site edit relative URL. Access to this URL switch user to the editing mode if is authorized to this mode.
Public property Static member	RenderWebPartIDCssClass	If true, the web part ID CSS class is rendered for web parts.
Public property Static member	SafeMode	If true, safe mode is required (only for new design mode).
Public property Static member	ShowDevicePreviewRotator	Indicates whether the device rotate button should be available.
Public property Static member	ShowDeviceSelection	Indicates whether device selection button should be available.
Public property Static member	ShowOrphanedLayoutWebPartZones	If true, the orphaned web part zones from layout web parts will be shown in design mode.
Public property Static member	ShowOrphanedWebPartZones	If true, the orphaned web part zones will be shown in design mode.

Methods

	Name	Description
Public method Static member	AddComponentsCSS	Links component style sheets to the page. Styles of the following objects are included: web parts, page templates, page layouts, web part layouts, web part containers, transformations and device layouts.
Public method Static member	AddNewWebPart	Adds the new web part to the page and returns its instance.
Public method Static member	AddNewWidget	Adds the new widget to the page and returns its instance.
Public method Static member	CollectControlsOfType<ControlType>	Returns the list of all controls matching the given control type
Public method Static member	CollectEditableControls(Control)	Returns the list of all the Editable controls within the given control.
Public method Static member	CollectEditableControls(Control, Boolean)	Returns the list of all the Editable controls within the given control.
Public method Static member	CollectEditableControls(Control, Boolean, Boolean)	Returns the list of all the Editable controls within the given control.
Public method Static member	CollectPlaceholders	Returns the hashtable of all the CMSPagePlaceholders within the given control (searches only for the level 0 placeholders, does not search recursively in the placeholders).
Public method Static member	CollectWebParts	Returns the list of all the WebParts within the given control (searches only for the level 0 placeholders, does not search recursively in the placeholders).
Public method Static member	CollectWebPartZones	Returns the list of all the WebPartZones within the given control (searches only for the level 0 placeholders, does not search recursively in the placeholders).
Public method Static member	CombineRegisterCode	Combines the register code blocks and avoids duplicated declarations.
Public method Static member	CombineWithDefaultValues	Combines widget info with default XML system properties.
Public method Static member	FindManager	Finds the Portal manager within the controls structure.
Public method Static member	FindPageManager(Control)	Tries to find the page manager within the controls structure.
Public method Static member	FindPageManager(Page)	Find page manager within the given page.
Public method Static member	FindParentPlaceholder	Finds the parent page placeholder within the controls structure.
Public method Static member	GetAddInlineWidgetScript	Gets the javascript code which ensures adding a new inline widget to the page.
Public method Static member	GetDisabledFormElementAttributes	Gets the HTML attributes for the disabled form element
Public method Static member	GetHtmlEditorAreaCss	Returns path to the default editor css file for the specified site.
Public method Static member	GetIconHtml	Gets the web part / widget / page template icon HTML.
Public method Static member	GetPageTemplateASPXCode	Gets the page template ASPX code.
Public method Static member	GetUILocalizationCulture	Returns a code of culture which should be used for localization while taking into account current ViewMode. Only in case of LiveSite, UserWidgets or UserWidgetsDisabled the culture of content is returned, otherwise context of user interface is assumed and current user's preferred UI culture is returned.
Public method Static member	GetWebPartASPXCode	Gets the ASPX code for the web part.
Public method Static member	GetWebPartControl	Gets the web part control instance from given control.
Public method Static member	GetWebPartZoneASPXCode	Gets the web part zone ASPX code.
Public method Static member	GetWorkflowViewMode	Gets the view mode type with dependence on current node workflow step
Public method Static member	IsOnSiteEditingEnabled	Gets the value that indicates whether on site editing is enabled for specific site name
Public method Static member	LocalizeStringForUI	Localizes a given resourceString according to current ViewMode. Use this method to ensure correct localization of UI components in various view modes. The target culture is determined using GetUILocalizationCulture() method.
Public method Static member	RegisterEditableControl	Registers the editable control.
Public method Static member	RegisterLayoutsScript	Registers the layouts script