Click or drag to resize
DocumentActionContext Class
Document action context. Ensures context for the document actions block.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerDocumentActionContext
    CMS.BaseAbstractDataContainerDocumentActionContext
      CMS.BaseAbstractHierarchicalObjectDocumentActionContext
        CMS.BaseContextContainerDocumentActionContext
          CMS.BaseAbstractContextDocumentActionContext
            CMS.BaseAbstractActionContextDocumentActionContext
              CMS.BaseExtendedActionContextDocumentActionContext
                CMS.DocumentEngineDocumentActionContext

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 12.0.0
Syntax
C#
public sealed class DocumentActionContext : ExtendedActionContext<DocumentActionContext>

The DocumentActionContext type exposes the following members.

Constructors
  NameDescription
Public methodDocumentActionContext
Top
Properties
  NameDescription
Public propertyActionContext
Action context
(Inherited from ExtendedActionContextTContext.)
Public propertyAllowAsyncActions
Indicates if the actions can run asynchronously. Default is true, if the application is web site, otherwise false.
(Inherited from ExtendedActionContextTContext.)
Public propertyAllowInitUser
Indicates if the current user should be initialized.
(Inherited from ExtendedActionContextTContext.)
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyCreateSearchTask
Indicates if the search task should be created for the objects.
(Inherited from ExtendedActionContextTContext.)
Public propertyCreateVersion
Indicates if the object version should be created.
(Inherited from ExtendedActionContextTContext.)
Public propertyStatic memberCurrentGenerateDocumentAliases
Indicates if document aliases should be generated for processed documents.
Public propertyStatic memberCurrentHandleACLs
Indicates whether the ACL settings should be processed during the document operations.
Public propertyStatic memberCurrentPreserveACLHierarchy
Indicates whether the ACL hierarchy should be preserved on processed documents.
Public propertyStatic memberCurrentResetChanges
Indicates whether the changes made to the document instance should be reseted.
Public propertyStatic memberCurrentResetIsWaitingForTranslationFlag
Indicates whether the 'Document is waiting for translation' flag should be cleared.
Public propertyStatic memberCurrentSynchronizeFieldValues
Indicates whether field values should be synchronized on set for the document (SKU mappings etc.)
Public propertyStatic memberCurrentUseAutomaticOrdering
If true, automatic ordering is used for new nodes.
Public propertyDeletePhysicalFiles
Indicates whether a physical files should be deleted for attachments, meta files and media files.
(Inherited from ExtendedActionContextTContext.)
Public propertyDisconnected
Indicates if the objects within current context should behave as disconnected
(Inherited from ExtendedActionContextTContext.)
Public propertyDocumentNewOrder
Defines default order for new document creation.
Public propertyEnableLogContext
Indicates whether logging through log context (LogContext) is currently enabled.
(Inherited from ExtendedActionContextTContext.)
Public propertyEnableSmartSearchIndexer
Indicates whether a search task should be executed when it is created.
(Inherited from ExtendedActionContextTContext.)
Public propertyGenerateDocumentAliases
Indicates if document aliases should be generated for processed documents.
Public propertyHandleACLs
Indicates whether the ACL settings should be processed during the document operations.
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 propertyLogEvents
Indicates if the events should be logged.
(Inherited from ExtendedActionContextTContext.)
Public propertyLogExport
Indicates if the export tasks should be logged.
(Inherited from ExtendedActionContextTContext.)
Public propertyLogIntegration
Indicates if the integration tasks should be logged.
(Inherited from ExtendedActionContextTContext.)
Public propertyLogSynchronization
Indicates if the staging tasks should be logged.
(Inherited from ExtendedActionContextTContext.)
Public propertyLogWebFarmTasks
Indicates if the web farm tasks should be logged.
(Inherited from ExtendedActionContextTContext.)
Protected propertyOriginalData
Previous context data
(Inherited from AbstractActionContextTContext.)
Public propertyPreserveACLHierarchy
Indicates whether the ACL hierarchy should be preserved on processed documents.
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.)
Public propertyResetChanges
Indicates whether the changes made to the document instance should be reseted.
Public propertyResetIsWaitingForTranslationFlag
Indicates whether the 'Document is waiting for translation' flag should be cleared.
Public propertyRestoreOriginal
If true, the original values are restored in the context
(Inherited from AbstractActionContextTContext.)
Public propertySendEmails
Indicates if email should be sent.
(Inherited from ExtendedActionContextTContext.)
Public propertySendNotifications
Indicates if the notifications should be sent.
(Inherited from ExtendedActionContextTContext.)
Public propertySynchronizeFieldValues
Indicates whether field values should be synchronized on set for the document (SKU mappings etc.)
Public propertyThreadGuid
Guid of the current CMSTread. Guid.Empty when execution is not running under CMSThread.
(Inherited from ExtendedActionContextTContext.)
Public propertyTouchCacheDependencies
Indicates if the objects cache dependencies should be touched.
(Inherited from ExtendedActionContextTContext.)
Public propertyTouchParent
Indicates if the objects within current context should touch parent object
(Inherited from ExtendedActionContextTContext.)
Public propertyUpdateRating
Indicates whether a user activity points should be updated.
(Inherited from ExtendedActionContextTContext.)
Public propertyUpdateSystemFields
Indicates if the system fields should be updated.
(Inherited from ExtendedActionContextTContext.)
Public propertyUpdateTimeStamp
Indicates if the objects time stamps should be updated.
(Inherited from ExtendedActionContextTContext.)
Public propertyUpdateUserCounts
Indicates whether a user activity points should be updated.
(Inherited from ExtendedActionContextTContext.)
Public propertyUseAutomaticOrdering
If true, automatic ordering is used for new nodes.
Public propertyUseCacheForSynchronizationXMLs
Indicates if cache should be used for data operations.
(Inherited from ExtendedActionContextTContext.)
Public propertyUseGlobalAdminContext
Indicates if global admin context should be used.
(Inherited from ExtendedActionContextTContext.)
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyUseLocalProperties
If true, the object uses local properties
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyUser
User of the context.
(Inherited from ExtendedActionContextTContext.)
Top
Methods
  NameDescription
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 methodDisableAll
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 ExtendedActionContextTContext.)
Public methodDisableLogging
Disables logging of event log, staging and export tasks
(Inherited from ExtendedActionContextTContext.)
Public methodDispose
Disposes the object
(Inherited from ExtendedActionContextTContext.)
Public methodEnsureCurrent (Inherited from ContextContainerTParent.)
Public methodGetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodGetPropertyType
Gets the type of the given property
(Inherited from AbstractHierarchicalObjectTObject.)
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.)
Protected methodRestoreOriginalValues
Restores the original values to the context
(Overrides AbstractActionContextTContextRestoreOriginalValues.)
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.)
Protected methodStoreOriginalValueTValue(NullableTValue, TValue)
Stores current value as the original value if original value hasn't been stored yet.
(Inherited from AbstractActionContextTContext.)
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
See Also