DocumentContext Class

Provides context of document related properties.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<DocumentContext>
    CMS.Base.AbstractDataContainer<DocumentContext>
      CMS.Base.AbstractHierarchicalObject<DocumentContext>
        CMS.Base.ContextContainer<DocumentContext>
          CMS.Base.AbstractContext<DocumentContext>
            CMS.DocumentEngine.DocumentContext

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

Syntax

public class DocumentContext : AbstractContext<DocumentContext>

The DocumentContext type exposes the following members.

Constructors

	Name	Description
Public method	DocumentContext

Properties

	Name	Description
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property Static member	CurrentAliasPath	Returns current document aliaspath.
Public property Static member	CurrentAttachment	Returns the current document attachment (only for file document type).
Public property Static member	CurrentBodyClass	Current page body class.
Public property Static member	CurrentCultureInvariantPageInfo	Returns the current culture invariant page info object.
Public property Static member	CurrentDescription	Current page description.
Public property Static member	CurrentDocType	Current page document type.
Public property Static member	CurrentDocument	Returns the current document node.
Public property Static member	CurrentDocumentCulture	Returns the current document culture.
Public property Static member	CurrentDocumentOwner	Returns the current document owner.
Public property Static member	CurrentDocumentParent	Returns parent of the current document node.
Public property Static member	CurrentDocumentStylesheet	Returns the current document CSS stylesheet.
Public property Static member	CurrentDocumentStylesheetName	Returns the current document CSS stylesheet name.
Public property Static member	CurrentKeyWords	Current page keywords.
Public property Static member	CurrentPageInfo	Returns the current page info object.
Public property Static member	CurrentParentPageInfos	Gets or sets the ordered list of parent page info objects, which are used on current page. These page info should be used as read-only.
Public property Static member	CurrentResolver	Current macro resolver.
Public property Static member	CurrentTemplate	Current page template
Public property Static member	CurrentTitle	Current page title with resolved macros.
Public property Static member	EditedDocument	Document edited by the current page.
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	OriginalAliasPath	Returns alias path corresponding to current URL.
Public property Static member	OriginalPageInfo	Returns the original page info object if site is in test and current page info belongs to variant.
Protected property Static member	PageResultUrlPath	Gets or sets the URL path of the current request.
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>.)
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 Static member	AddDefaultOutputCacheDependencies	Adds the default output cache dependencies to the request output.
Public method	ClearCurrent	Clears the current context value (Inherited from ContextContainer<TParent>.)
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	EnsureCurrent	Creates the internal ContextContainer<TParent> storage if it does not exist yet. (Inherited from ContextContainer<TParent>.)
Public method Static member	GetCultureClass	Gets the culture specific CSS class name.
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 Static member	GetUICultureClass	Gets the UI culture specific CSS class name.
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 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>.)