UIContext Class

UI context properties.

Inheritance Hierarchy

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

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

Syntax

public class UIContext : AbstractContext<UIContext>, 
	INotCopyThreadItem

The UIContext type exposes the following members.

Constructors

	Name	Description
Public method	UIContext

Methods

	Name	Description
Public method	ClearCurrent	Clears the current context value (Inherited from ContextContainer<TParent>.)
Public method	Clone	Clones current UI context and creates new instance
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	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	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject<TObject>.)
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	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	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	TryGetProperty(String, Object)	Gets value from collection (Overrides AbstractHierarchicalObject<TObject>.TryGetProperty(String, Object).)
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property. (Overrides AbstractHierarchicalObject<TObject>.TryGetProperty(String, Object, Boolean).)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)

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	AnchorLinks	List of anchor links for quick navigation.
Public property	AssignedControl	Control to which UI context is assigned. If null context belongs to main page.
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	ContextResolver	UI context resolver.
Public property	Data	Gets context data for UI.
Public property	DisplayBreadcrumbs	If true, the breadcrumbs should be displayed
Public property Static member	DisplaySplitMode	Indicates if split mode should be displayed.
Public property	DisplayTitle	If true, the title should be displayed
Public property	EditedObject	Object edited by the current page.
Public property	EditedObjectParent	Parent of the object edited by the current page.
Public property	ElementGuid	GUID for element to display
Public property	ElementName	Gets the current UI element name.
Public property	HideControlOnError	If true, the context hides the parent control in case of error
Public property	IsDefault	Returns true if the context is the default request context (Inherited from ContextContainer<TParent>.)
Public property	IsDialog	Indicates whether page is dialog or nested in a dialog. Use IsRootDialog property to check the top dialog page.
Public property	IsRootDialog	Indicates whether page is root dialog (top dialog page with header and footer)
Public property	Item	Override indexer, add fallback to querystring (Overrides AbstractHierarchicalObject<TObject>.Item[String].)
Public property	Key	Unique container key (Inherited from ContextContainer<TParent>.)
Public property	LoadDataFromParent	Indicates whether data sould be loaded from parent context
Public property	ObjectID	Object ID
Public property	ParentObjectID	Parent object ID
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	ResolveMacros	Indicates whether property should be resolved with context's resolver.
Public property	ResourceName	Gets the resource name.
Public property	RootElementID	Root element ID
Public property	Secure	Secure wrapper for properties in special secure mode.
Public property	SiteID	Site ID
Public property Static member	SplitMode	Split mode view (vertical/horizontal).
Public property Static member	SplitModeCultureCode	User culture code for culture version comparison.
Public property Static member	SplitModeSyncScrollbars	Indicates if scrollbars should be synchronized in split mode.
Public property	UIElement	UI element for current context
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>.)

Events

	Name	Description
Public event	OnGetValue	Event fired when the UI context dynamic data is requested