DocumentActionContext Class

Document action context. Ensures context for the document actions block.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<DocumentActionContext>
    CMS.Base.AbstractDataContainer<DocumentActionContext>
      CMS.Base.AbstractHierarchicalObject<DocumentActionContext>
        CMS.Base.ContextContainer<DocumentActionContext>
          CMS.Base.AbstractContext<DocumentActionContext>
            CMS.Base.AbstractActionContext<DocumentActionContext>
              CMS.Base.ExtendedActionContext<DocumentActionContext>
                CMS.DocumentEngine.DocumentActionContext

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

Syntax

public sealed class DocumentActionContext : ExtendedActionContext<DocumentActionContext>

The DocumentActionContext type exposes the following members.

Constructors

	Name	Description
Public method	DocumentActionContext

Properties

	Name	Description
Public property	ActionContext	Action context (Inherited from ExtendedActionContext<TContext>.)
Public property	AllowAsyncActions	Indicates if the actions can run asynchronously. Default is true, if the application is web site, otherwise false. (Inherited from ExtendedActionContext<TContext>.)
Public property	AllowInitUser	Indicates if the current user should be initialized. (Inherited from ExtendedActionContext<TContext>.)
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	CreateSearchTask	Indicates if the search task should be created for the objects. (Inherited from ExtendedActionContext<TContext>.)
Public property	CreateVersion	Indicates if the object version should be created. (Inherited from ExtendedActionContext<TContext>.)
Public property Static member	CurrentHandleACLs	Indicates whether the ACL settings should be processed during the document operations.
Public property Static member	CurrentPreserveACLHierarchy	Indicates whether the ACL hierarchy should be preserved on processed documents.
Public property Static member	CurrentResetChanges	Indicates whether the changes made to the document instance should be reseted.
Public property Static member	CurrentResetIsWaitingForTranslationFlag	Indicates whether the 'Document is waiting for translation' flag should be cleared.
Public property Static member	CurrentSynchronizeFieldValues	Indicates whether field values should be synchronized on set for the document (SKU mappings etc.)
Public property Static member	CurrentUseAutomaticOrdering	If true, automatic ordering is used for new nodes.
Public property	DeletePhysicalFiles	Indicates whether a physical files should be deleted for attachments, meta files and media files. (Inherited from ExtendedActionContext<TContext>.)
Public property	Disconnected	Indicates if the objects within current context should behave as disconnected (Inherited from ExtendedActionContext<TContext>.)
Public property	DocumentNewOrder	Defines default order for new document creation.
Public property	EnableLogContext	Indicates whether logging through log context (LogContext) is currently enabled. (Inherited from ExtendedActionContext<TContext>.)
Public property	EnableSmartSearchIndexer	Indicates whether a search task should be executed when it is created. (Inherited from ExtendedActionContext<TContext>.)
Public property	HandleACLs	Indicates whether the ACL settings should be processed during the document operations.
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	LogEvents	Indicates if the events should be logged. (Inherited from ExtendedActionContext<TContext>.)
Public property	LogExport	Indicates if the export tasks should be logged. (Inherited from ExtendedActionContext<TContext>.)
Public property	LogIntegration	Indicates if the integration tasks should be logged. (Inherited from ExtendedActionContext<TContext>.)
Public property	LogSynchronization	Indicates if the staging tasks should be logged. (Inherited from ExtendedActionContext<TContext>.)
Public property	LogWebFarmTasks	Indicates if the web farm tasks should be logged. (Inherited from ExtendedActionContext<TContext>.)
Protected property	OriginalData	Previous context data (Inherited from AbstractActionContext<TContext>.)
Public property	PreserveACLHierarchy	Indicates whether the ACL hierarchy should be preserved on processed documents.
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	ResetChanges	Indicates whether the changes made to the document instance should be reseted.
Public property	ResetIsWaitingForTranslationFlag	Indicates whether the 'Document is waiting for translation' flag should be cleared.
Public property	RestoreOriginal	If true, the original values are restored in the context (Inherited from AbstractActionContext<TContext>.)
Public property	SendEmails	Indicates if email should be sent. (Inherited from ExtendedActionContext<TContext>.)
Public property	SendNotifications	Indicates if the notifications should be sent. (Inherited from ExtendedActionContext<TContext>.)
Public property	SynchronizeFieldValues	Indicates whether field values should be synchronized on set for the document (SKU mappings etc.)
Public property	ThreadGuid	Guid of the current CMSTread. Guid.Empty when execution is not running under CMSThread. (Inherited from ExtendedActionContext<TContext>.)
Public property	TouchCacheDependencies	Indicates if the objects cache dependencies should be touched. (Inherited from ExtendedActionContext<TContext>.)
Public property	TouchParent	Indicates if the objects within current context should touch parent object (Inherited from ExtendedActionContext<TContext>.)
Public property	UpdateSystemFields	Indicates if the system fields should be updated. (Inherited from ExtendedActionContext<TContext>.)
Public property	UpdateTimeStamp	Indicates if the objects time stamps should be updated. (Inherited from ExtendedActionContext<TContext>.)
Public property	UpdateUserCounts	Indicates whether a user activity points should be updated. (Inherited from ExtendedActionContext<TContext>.)
Public property	UseAutomaticOrdering	If true, automatic ordering is used for new nodes.
Public property	UseCacheForSynchronizationXMLs	Indicates if cache should be used for data operations. (Inherited from ExtendedActionContext<TContext>.)
Public property	UseGlobalAdminContext	Indicates if global admin context should be used. (Inherited from ExtendedActionContext<TContext>.)
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>.)
Public property	User	User of the context. (Inherited from ExtendedActionContext<TContext>.)

Methods

	Name	Description
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	DisableAll	Disables logging for synchronization, event log, web farm tasks, versioning and cache dependencies Disables timestamp update Disables object invalidation Disables cache usage Disables asynchronous actions Disables sending of emails (Inherited from ExtendedActionContext<TContext>.)
Public method	DisableLogging	Disables logging of event log, staging and export tasks (Inherited from ExtendedActionContext<TContext>.)
Public method	Dispose	Disposes the object (Inherited from ExtendedActionContext<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 the original values to the context (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>.)