ContextContainer<TParent> Class

Container class for storing ambient context data. The container is backed by both the HTTP context items (if available) and an AsyncLocal<T> field so that the data are available along the asynchronous control flow in a web application.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<TParent>
    CMS.Base.AbstractDataContainer<TParent>
      CMS.Base.AbstractHierarchicalObject<TParent>
        CMS.Base.ContextContainer<TParent>
          CMS.Base.AbstractContext<TContext>

Namespace: CMS.Base
Assembly: CMS.Base (in CMS.Base.dll) Version: 13.0.131

Syntax

public class ContextContainer<TParent> : AbstractHierarchicalObject<TParent>
where TParent : new(), ContextContainer<TParent>

Type Parameters

TParent

The ContextContainer<TParent> type exposes the following members.

Constructors

	Name	Description
Public method	ContextContainer<TParent>

Fields

	Name	Description
Protected field Static member	AddToContainers	If true (default), the object is added to the thread containers so that it is cloned for a new thread

Properties

	Name	Description
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Protected property Static member	Current	Current request data
Public property	IsDefault	Returns true if the context is the default request context
Public property	Item	Gets the value of particular property (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	Key	Unique container key
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	Clear	Clears the current context value
Public method	ClearCurrent	Clears the current context value
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.
Protected method Static member	EnsureValue<TValue>	Ensures the value
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
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>.)

Remarks

To prevent the ambient context data from flowing along the asynchronous control flow or to child threads use the SuppressFlow() method.

The CMSThread class prevents the ambient context data from implicitly flowing. Instead, the context data are explicitly cloned upon initializing the new thread.