Click or drag to resize
UIContext Class
UI context properties.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerUIContext
    CMS.BaseAbstractDataContainerUIContext
      CMS.BaseAbstractHierarchicalObjectUIContext
        CMS.BaseContextContainerUIContext
          CMS.BaseAbstractContextUIContext
            CMS.PortalEngineUIContext

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

The UIContext type exposes the following members.

Constructors
  NameDescription
Public methodUIContext
Top
Methods
  NameDescription
Public methodClearCurrent
Clears the current context value
(Inherited from ContextContainerTParent.)
Public methodClone
Clones current UI context and creates new instance
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 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 methodHasSetter
Returns true if given property has a setter
(Inherited from AbstractHierarchicalObjectTObject.)
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 methodSetAsCurrent
Sets the current instance as the current thread item
(Inherited from ContextContainerTParent.)
Public methodSetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodTryGetProperty(String, Object)
Gets value from collection
(Overrides AbstractHierarchicalObjectTObjectTryGetProperty(String, Object).)
Public methodTryGetProperty(String, Object, Boolean)
Returns value of property.
(Overrides AbstractHierarchicalObjectTObjectTryGetProperty(String, Object, Boolean).)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractSimpleDataContainerTObject.)
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 propertyAnchorLinks
List of anchor links for quick navigation.
Public propertyAssignedControl
Control to which UI context is assigned. If null context belongs to main page.
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyContextResolver
UI context resolver.
Public propertyData
Gets context data for UI.
Public propertyDisplayBreadcrumbs
If true, the breadcrumbs should be displayed
Public propertyStatic memberDisplaySplitMode
Indicates if split mode should be displayed.
Public propertyDisplayTitle
If true, the title should be displayed
Public propertyEditedObject
Object edited by the current page.
Public propertyEditedObjectParent
Parent of the object edited by the current page.
Public propertyElementGuid
GUID for element to display
Public propertyElementName
Gets the current UI element name.
Public propertyHideControlOnError
If true, the context hides the parent control in case of error
Public propertyIsDefault
Returns true if the context is the default request context
(Inherited from ContextContainerTParent.)
Public propertyIsDialog
Indicates whether page is dialog or nested in a dialog. Use IsRootDialog property to check the top dialog page.
Public propertyIsRootDialog
Indicates whether page is root dialog (top dialog page with header and footer)
Public propertyItem
Override indexer, add fallback to querystring
(Overrides AbstractHierarchicalObjectTObjectItemString.)
Public propertyKey
Unique container key
(Inherited from ContextContainerTParent.)
Public propertyLoadDataFromParent
Indicates whether data sould be loaded from parent context
Public propertyObjectID
Object ID
Public propertyParentObjectID
Parent object ID
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 propertyResolveMacros
Indicates whether property should be resolved with context's resolver.
Public propertyResourceName
Gets the resource name.
Public propertyRootElementID
Root element ID
Public propertySecure
Secure wrapper for properties in special secure mode.
Public propertySiteID
Site ID
Public propertyStatic memberSplitMode
Split mode view (vertical/horizontal).
Public propertyStatic memberSplitModeCultureCode
User culture code for culture version comparison.
Public propertyStatic memberSplitModeSyncScrollbars
Indicates if scrollbars should be synchronized in split mode.
Public propertyUIElement
UI element for current context
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyUseLocalProperties
If true, the object uses local properties
(Inherited from AbstractHierarchicalObjectTObject.)
Top
Events
  NameDescription
Public eventOnGetValue
Event fired when the UI context dynamic data is requested
Top
See Also