SynchronizationActionContext Class

Context for synchronization and task processing.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<SynchronizationActionContext>
    CMS.Base.AbstractDataContainer<SynchronizationActionContext>
      CMS.Base.AbstractHierarchicalObject<SynchronizationActionContext>
        CMS.Base.ContextContainer<SynchronizationActionContext>
          CMS.Base.AbstractContext<SynchronizationActionContext>
            CMS.Base.AbstractActionContext<SynchronizationActionContext>
              CMS.Synchronization.SynchronizationActionContext

Namespace: CMS.Synchronization
Assembly: CMS.Synchronization (in CMS.Synchronization.dll) Version: 9.0.0

Syntax

public sealed class SynchronizationActionContext : AbstractActionContext<SynchronizationActionContext>

The SynchronizationActionContext type exposes the following members.

Constructors

	Name	Description
Public method Code example	SynchronizationActionContext	Creates context that affects logging additional information with staging task within using block.

Properties

	Name	Description
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property Static member	CurrentLogUserWithTask	Indicates whether user should be logged within the task creation.
Public property Static member	CurrentTaskGroups	Gets task group collection for current user context.
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	LogUserWithTask	Sets the value that indicates whether user should be logged within the task creation.
Protected property	OriginalData	Previous context data (Inherited from AbstractActionContext<TContext>.)
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	RestoreOriginal	If true, the original values are restored in the context (Inherited from AbstractActionContext<TContext>.)
Public property	TaskGroups	Sets the collection of tasks used within the current task processing.
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	ClearCurrent	Clears the current context value (Inherited from ContextContainer<TParent>.)
Public method	CloneForNewThread	Ensures values in current thread for context and clones synchronization action context object for new thread. (Overrides AbstractContext<TContext>.CloneForNewThread().)
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	Dispose	Disposes the object. (Inherited from AbstractActionContext<TContext>.)
Public method	EnsureCurrent	Creates the internal ContextContainer<TParent> storage if it does not exist yet. (Inherited from ContextContainer<TParent>.)
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>.)
Protected method	RestoreOriginalValues	Restores original values. (Overrides AbstractActionContext<TContext>.RestoreOriginalValues().)
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>.)
Protected method	StoreOriginalValue<TValue>(Nullable<TValue>, TValue)	Stores current value as the original value if original value hasn't been stored yet. (Inherited from AbstractActionContext<TContext>.)
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>.)