PortalContext Class

Portal context methods.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<PortalContext>
    CMS.Base.AbstractDataContainer<PortalContext>
      CMS.Base.AbstractHierarchicalObject<PortalContext>
        CMS.Base.ContextContainer<PortalContext>
          CMS.Base.AbstractContext<PortalContext>
            CMS.PortalEngine.PortalContext

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 8.2.23

Syntax

public class PortalContext : AbstractContext<PortalContext>

The PortalContext type exposes the following members.

Constructors

	Name	Description
Public method	PortalContext

Methods

	Name	Description
Public method	ClearCurrent	Clears the current context value (Inherited from ContextContainer<TParent>.)
Public method Static member	ClearEditorWidgets	Clears the temporary interlayer which holds modified editor widgets.
Public method	CloneForNewThread	Clones the object for new thread (Inherited from AbstractContext<TContext>.)
Public method	CombineWith	Combines current instance with other properties (modifies current instace!). List properties are merged from all the participating typeinfos, other properties are taken as first non-null value (non-null is determined by nullValues collection). (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method Static member	EnsurePortalMode	Ensures the portal mode.
Public method Static member	EnsureViewMode	Ensures the view mode value in a variable and returns it.
Public method Static member	GetEditorWidgets	Gets modified editor widgets from a temporary interlayer.
Public method	GetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	GetPropertyType	Gets the type of the given property (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method Static member	GetViewMode	Gets current view mode.
Public method	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject<TObject>.)
Public method Static member	IsDesignMode	Returns true if the given mode is considered design mode (with web parts active)
Public method Static member	IsPortalMode	Returns true if the given mode is mode displaying the document.
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Registers the Columns of this object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterProperties	Registers the properties of this object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Func<TObject, Object>)	Registers the given property to the object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Object, Func<TObject, Object, Object>)	Registers the given parameterized property to the object. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method Static member	SaveEditorWidgets	Saves the modified editor widgets into a temporary interlayer.
Public method	SetAsCurrent	Sets the current instance as the current thread item (Inherited from ContextContainer<TParent>.)
Public method	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method Static member	SetRequestViewMode	Sets current request view mode.
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method Static member	SetViewMode	Sets current view mode.
Public method	TryGetProperty(String, Object)	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method Static member	UpdateViewMode	Updates the current view mode

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property Static member	ContentPersonalizationEnabled	Indicates whether to show the Content personalization variant slider and render all the web part/zone variants.
Public property Static member	ContentPersonalizationVariantsEnabled	Gets or sets the value that indicates whether current page has at least one personalization variant
Public property Static member	CurrentComponents	List of web part containers used by current page. Hashtable [containerName.ToLowerCSafe() -> WebPartContainerInfo]
Public property Static member	CurrentEditableControls	Gets the list of editable controls on current page.
Public property Static member	CurrentPageManager	Gets or sets the current page manager
Public property Static member	CurrentSiteStylesheet	Returns the current site stylesheet info.
Public property Static member	CurrentSiteStylesheetName	Returns current site stylesheet name.
Public property Static member	CurrentUserIsDesigner	Indicates whether the current user has designer rights and can access web part properties (UI element)
Public property Static member	DashboardName	Gets or sets the current dashboard name.
Public property Static member	DashboardSiteName	Gets or sets the current dashboard site name.
Public property Static member	EditableControlsHidden	Gets or sets the value that indicates whether current page may contain some hidden editable controls
Public property	IsDefault	Returns true if the context is the default request context (Inherited from ContextContainer<TParent>.)
Public property	Item	Gets the value of particular property (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	Key	Unique container key (Inherited from ContextContainer<TParent>.)
Public property Static member	MVTCombinationPanelChanged	Gets the value that indicates whether panel combination was changed
Public property Static member	MVTVariantsEnabled	Indicates whether to show the MVT variant slider and render all the web part/zone variants. This value will be true only when there are defined any multivariate tests for the current document.
Public property	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredProperties	Registered properties (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredPropertiesObject	Registered properties object (Inherited from AbstractHierarchicalObject<TObject>.)
Public property Static member	UIContext	Gets the current UIContext.
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	UseLocalProperties	If true, the object uses local properties (Inherited from AbstractHierarchicalObject<TObject>.)
Public property Static member	ViewMode	Returns current ViewMode.