Click or drag to resize
DocumentContext Class
Request document values
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerDocumentContext
    CMS.BaseAbstractDataContainerDocumentContext
      CMS.BaseAbstractHierarchicalObjectDocumentContext
        CMS.BaseContextContainerDocumentContext
          CMS.BaseAbstractContextDocumentContext
            CMS.DocumentEngineDocumentContext

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

The DocumentContext type exposes the following members.

Constructors
  NameDescription
Public methodDocumentContext
Top
Methods
  NameDescription
Public methodStatic memberAddDefaultOutputCacheDependencies
Adds the default output cache dependencies to the request output.
Public methodClearCurrent
Clears the current context value
(Inherited from ContextContainerTParent.)
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 memberGetBrowserClass
Gets the browser specific CSS class name.
Public methodStatic memberGetContextParametersDataRow
Returns datarow with CMSContext parameters.
Public methodStatic memberGetCultureClass
Gets the culture specific CSS class name.
Public methodGetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodGetPropertyType
Gets the type of the given property
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodStatic memberGetUICultureClass
Gets the UI culture specific CSS class name.
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 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.)
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 memberCurrentAliasPath
Returns current document aliaspath.
Public propertyStatic memberCurrentAttachment
Returns the current document attachment (only for CMS.File document type).
Public propertyStatic memberCurrentBodyClass
Current page body class.
Public propertyStatic memberCurrentCultureInvariantPageInfo
Returns the current culture invariant page info object.
Public propertyStatic memberCurrentDescription
Current page description.
Public propertyStatic memberCurrentDocType
Current page document type.
Public propertyStatic memberCurrentDocument
Returns the current document node.
Public propertyStatic memberCurrentDocumentCulture
Returns the current document culture.
Public propertyStatic memberCurrentDocumentOwner
Returns the current document owner.
Public propertyStatic memberCurrentDocumentParent
Returns parent of the current document node.
Public propertyStatic memberCurrentDocumentStylesheet
Returns the current document CSS stylesheet.
Public propertyStatic memberCurrentDocumentStylesheetName
Returns current document stylesheet name.
Public propertyStatic memberCurrentKeyWords
Current page keywords.
Public propertyStatic memberCurrentPageInfo
Returns the current page info object.
Public propertyStatic memberCurrentParentPageInfos
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 propertyStatic memberCurrentTemplate
Current page template
Public propertyStatic memberCurrentTitle
Current page title with resolved macros.
Public propertyStatic memberEditedDocument
Document edited by the current page.
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 memberOriginalAliasPath
Returns alias path corresponding to current URL.
Public propertyStatic memberOriginalPageInfo
Returns the original page info object if site is in test and current page info belongs to variant.
Protected propertyStatic memberPageResultUrlPath
Gets or sets the url path of the current request.
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.)
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
See Also