Click or drag to resize
BaseDocumentAction Class
Class for base document action
Inheritance Hierarchy
SystemObject
  CMS.WorkflowEngineBaseWorkflowActionTreeNode, BaseInfo, WorkflowActionEnum
    CMS.DocumentEngineDocumentWorkflowAction
      CMS.DocumentEngineBaseDocumentAction
        More...

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131
Syntax
C#
public abstract class BaseDocumentAction : DocumentWorkflowAction

The BaseDocumentAction type exposes the following members.

Constructors
  NameDescription
Protected methodBaseDocumentAction
Top
Properties
  NameDescription
Public propertyActionDefinition
Action definition.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyActionStep
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyArguments
Action arguments
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyComment
Comment used when action moves to next step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyInfoObject
Current info object.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyInitialStep
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyMacroResolver
Macro resolver for action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyManager
Manager.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected propertyNode
Current document.
(Inherited from DocumentWorkflowAction.)
Public propertyOriginalStep
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyParameters
Parameters of action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected propertySourceAliasPath
Source alias path
Protected propertySourceCombineWithDefaultCulture
Specifies if return the default culture document when specified culture not found.
Protected propertySourceCulture
Source document culture code
Protected propertySourceNode
Node to be copied
Protected propertySourceSite
Source site
Protected propertySourceSiteName
Source site name
Public propertyStateObject
Current state object.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyUser
User running action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyWorkflow
Current workflow.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected propertyWorkflowManager
Workflow manager
(Inherited from DocumentWorkflowAction.)
Top
Methods
  NameDescription
Public methodCode exampleExecute
Executes action. You can use parameters to allow users to modify the behavior.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected methodGetDefaultMacroResolver
Prepares macro resolver for usage.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected methodGetResolvedParameterReturnType
Gets resolved value of parameter.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public methodLogMessage
Logs message to event log.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public methodProcess
Processes action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected methodRefreshNode
Refreshes node instance
(Inherited from DocumentWorkflowAction.)
Top
See Also
Inheritance Hierarchy