CMSDataContext Class

Data context.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<CMSDataContext>
    CMS.Base.AbstractDataContainer<CMSDataContext>
      CMS.Base.AbstractHierarchicalObject<CMSDataContext>
        CMS.DocumentEngine.CMSDataContextBase<CMSDataContext>
          CMS.DocumentEngine.CMSDataContext

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 11.0.0

Syntax

public class CMSDataContext : CMSDataContextBase<CMSDataContext>

The CMSDataContext type exposes the following members.

Constructors

	Name	Description
Public method	CMSDataContext()	Constructor
Public method	CMSDataContext(String)	Constructor.

Properties

	Name	Description
Public property	AllSites	Gets the collection of all sites.
Public property	AlternativeForms	Collection of alternative forms indexed by their full name
Public property	BrowserHelper	Browser information
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	CSS	CSS styles
Public property Static member	Current	Returns current data context.
Public property	CurrentDevice	Current device info.
Public property	DeviceProfileInfo	Current device profile info.
Public property	DeviceProfileInfoName	Current device profile name.
Public property	Documents	Gets the collection of all documents on the site (Inherited from CMSDataContextBase<ParentType>.)
Public property	GlobalObjects	Returns the list of all global objects (entry point to global objects).
Public property	IsCachedObject	If true, the object is cached within the system for later use (Inherited from CMSDataContextBase<ParentType>.)
Public property	IsDisconnected	Returns true if this object is disconnected from the database (Inherited from CMSDataContextBase<ParentType>.)
Public property	Item	Gets the value of particular property (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	LoadObjectsLock	Gets lock object to synchronize LoadObjects() execution. (Inherited from CMSDataContextBase<ParentType>.)
Public property	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	Queries	Collection of queries indexed by their full name
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	RootDocument	Gets the root document of current site. (Inherited from CMSDataContextBase<ParentType>.)
Public property	Settings	Obsolete. Gets the object encapsulating all the settings categories with its setting. (Inherited from CMSDataContextBase<ParentType>.)
Public property	SiteName	Context site name. (Inherited from CMSDataContextBase<ParentType>.)
Public property	SiteObjects	Returns the list of all site objects (entry point to site objects). (Inherited from CMSDataContextBase<ParentType>.)
Public property	Transformations	Collection of transformations indexed by their full name
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>.)

Methods

	Name	Description
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	LoadObjects	Loads GlobalObjects and SiteObjects. The method's execution is synchronized by LoadObjectsLock. (Overrides CMSDataContextBase<ParentType>.LoadObjects().)
Protected method	LoadObjectType	Loads the given object type. The method is called during LoadObjects() execution and is inherently synchronized by LoadObjectsLock. (Overrides CMSDataContextBase<ParentType>.LoadObjectType(GeneralizedInfo, Int32).)
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 object properties. (Overrides CMSDataContextBase<ParentType>.RegisterProperties().)
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	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 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>.)