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: 13.0.131

Syntax

Copy

public sealed class SynchronizationActionContext : AbstractActionContext<SynchronizationActionContext>

The SynchronizationActionContext type exposes the following members.

Constructors

ProtectedInherited

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

Top

Properties

ProtectedInherited

	Name	Description
	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
	CurrentLogUserWithTask	Indicates whether user should be logged within the task creation.
	CurrentTaskGroups	Gets task group collection for current user context.
	IsDefault	Returns true if the context is the default request context (Inherited from ContextContainer<TParent>.)
	Item	Gets the value of particular property (Inherited from AbstractHierarchicalObject<TObject>.)
	Key	Unique container key (Inherited from ContextContainer<TParent>.)
	LogUserWithTask	Sets the value that indicates whether user should be logged within the task creation.
	OriginalData	Previous context data (Inherited from AbstractActionContext<TContext>.)
	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
	RegisteredProperties	Registered properties (Inherited from AbstractHierarchicalObject<TObject>.)
	RegisteredPropertiesObject	Registered properties object (Inherited from AbstractHierarchicalObject<TObject>.)
	RestoreOriginal	If true, the original values are restored in the context (Inherited from AbstractActionContext<TContext>.)
	TaskGroups	Sets the collection of tasks used within the current task processing.
	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)
	UseLocalProperties	If true, the object uses local properties (Inherited from AbstractHierarchicalObject<TObject>.)

Top

Methods

ProtectedInherited

	Name	Description
	ClearCurrent	Clears the current context value (Inherited from ContextContainer<TParent>.)
	CloneForNewThread	Ensures values in current thread for context and clones synchronization action context object for new thread. (Overrides AbstractContext<TContext>.CloneForNewThread().)
	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>.)
	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
	Dispose	Disposes the object. (Inherited from AbstractActionContext<TContext>.)
	EnsureCurrent	Creates the internal ContextContainer< TParent> storage if it does not exist yet. (Inherited from ContextContainer<TParent>.)
	GetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
	GetPropertyType	Gets the type of the given property (Inherited from AbstractHierarchicalObject<TObject>.)
	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject<TObject>.)
	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
	RegisterColumns	Registers the Columns of this object (Inherited from AbstractSimpleDataContainer<TObject>.)
	RegisterProperties	Registers the properties of this object (Inherited from AbstractHierarchicalObject<TObject>.)
	RegisterProperty(String, Func<TObject, Object>)	Registers the given property to the object (Inherited from AbstractHierarchicalObject<TObject>.)
	RegisterProperty(String, Object, Func<TObject, Object, Object>)	Registers the given parameterized property to the object. (Inherited from AbstractHierarchicalObject<TObject>.)
	RestoreOriginalValues	Restores original values. (Overrides AbstractActionContext<TContext>.RestoreOriginalValues().)
	SetAsCurrent	Sets the current instance as the current thread item (Inherited from ContextContainer<TParent>.)
	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
	StoreOriginalValue<TValue>(Nullable<TValue>, TValue)	Stores current value as the original value if original value hasn't been stored yet. (Inherited from AbstractActionContext<TContext>.)
	TryGetProperty(String, Object)	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
	TryGetProperty(String, Object, Boolean)	Returns value of property. (Inherited from AbstractHierarchicalObject<TObject>.)
	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)

Top

Reference

CMS.Synchronization Namespace