Click or drag to resize
PortalContext Class
Portal context methods.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerPortalContext
    CMS.BaseAbstractDataContainerPortalContext
      CMS.BaseAbstractHierarchicalObjectPortalContext
        CMS.BaseContextContainerPortalContext
          CMS.BaseAbstractContextPortalContext
            CMS.PortalEnginePortalContext

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 8.2.23
Syntax
C#
public class PortalContext : AbstractContext<PortalContext>

The PortalContext type exposes the following members.

Constructors
  NameDescription
Public methodPortalContext
Top
Methods
  NameDescription
Public methodClearCurrent
Clears the current context value
(Inherited from ContextContainerTParent.)
Public methodStatic memberClearEditorWidgets
Clears the temporary interlayer which holds modified editor widgets.
Public methodCloneForNewThread
Clones the object for new thread
(Inherited from AbstractContextTContext.)
Public methodCombineWith
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 AbstractHierarchicalObjectTObject.)
Public methodContainsColumn
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainerParentObjectType.)
Public methodStatic memberEnsurePortalMode
Ensures the portal mode.
Public methodStatic memberEnsureViewMode
Ensures the view mode value in a variable and returns it.
Public methodStatic memberGetEditorWidgets
Gets modified editor widgets from a temporary interlayer.
Public methodGetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodGetPropertyType
Gets the type of the given property
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodGetValue
Gets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodStatic memberGetViewMode
Gets current view mode.
Public methodHasSetter
Returns true if given property has a setter
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodStatic memberIsDesignMode
Returns true if the given mode is considered design mode (with web parts active)
Public methodStatic memberIsPortalMode
Returns true if the given mode is mode displaying the document.
Protected methodRegisterColumn(String, FuncTObject, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumn(String, FuncTObject, Object, FuncTObject, Object, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumns
Registers the Columns of this object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterProperties
Registers the properties of this object
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodRegisterProperty(String, FuncTObject, Object)
Registers the given property to the object
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodRegisterProperty(String, Object, FuncTObject, Object, Object)
Registers the given parameterized property to the object.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodStatic memberSaveEditorWidgets
Saves the modified editor widgets into a temporary interlayer.
Public methodSetAsCurrent
Sets the current instance as the current thread item
(Inherited from ContextContainerTParent.)
Public methodSetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodStatic memberSetRequestViewMode
Sets current request view mode.
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodStatic memberSetViewMode
Sets current view mode.
Public methodTryGetProperty(String, Object)
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodTryGetProperty(String, Object, Boolean)
Returns value of property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodStatic memberUpdateViewMode
Updates the current view mode
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Properties
  NameDescription
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyStatic memberContentPersonalizationEnabled
Indicates whether to show the Content personalization variant slider and render all the web part/zone variants.
Public propertyStatic memberContentPersonalizationVariantsEnabled
Gets or sets the value that indicates whether current page has at least one personalization variant
Public propertyStatic memberCurrentComponents
List of web part containers used by current page. Hashtable [containerName.ToLowerCSafe() -> WebPartContainerInfo]
Public propertyStatic memberCurrentEditableControls
Gets the list of editable controls on current page.
Public propertyStatic memberCurrentPageManager
Gets or sets the current page manager
Public propertyStatic memberCurrentSiteStylesheet
Returns the current site stylesheet info.
Public propertyStatic memberCurrentSiteStylesheetName
Returns current site stylesheet name.
Public propertyStatic memberCurrentUserIsDesigner
Indicates whether the current user has designer rights and can access web part properties (UI element)
Public propertyStatic memberDashboardName
Gets or sets the current dashboard name.
Public propertyStatic memberDashboardSiteName
Gets or sets the current dashboard site name.
Public propertyStatic memberEditableControlsHidden
Gets or sets the value that indicates whether current page may contain some hidden editable controls
Public propertyIsDefault
Returns true if the context is the default request context
(Inherited from ContextContainerTParent.)
Public propertyItem
Gets the value of particular property
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyKey
Unique container key
(Inherited from ContextContainerTParent.)
Public propertyStatic memberMVTCombinationPanelChanged
Gets the value that indicates whether panel combination was changed
Public propertyStatic memberMVTVariantsEnabled
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 propertyProperties
Properties available through the context.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyPropertyList
Used property list
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyRegisteredColumns
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumnsObject
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredProperties
Registered properties
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyRegisteredPropertiesObject
Registered properties object
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyStatic memberUIContext
Gets the current UIContext.
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyUseLocalProperties
If true, the object uses local properties
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyStatic memberViewMode
Returns current ViewMode.
Top
See Also