Click or drag to resize
DocumentWorkflowAction Class
Base document workflow action
Inheritance Hierarchy
SystemObject
  CMS.WorkflowEngineBaseWorkflowActionTreeNode, BaseInfo, WorkflowActionEnum
    CMS.DocumentEngineDocumentWorkflowAction
      More...

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 9.0.0
Syntax
C#
public abstract class DocumentWorkflowAction : BaseWorkflowAction<TreeNode, BaseInfo, WorkflowActionEnum>

The DocumentWorkflowAction type exposes the following members.

Constructors
  NameDescription
Protected methodDocumentWorkflowAction
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.
Public propertyOriginalStep
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyParameters
Parameters of action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
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
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
Top
See Also
Inheritance Hierarchy
SystemObject
  CMS.WorkflowEngineBaseWorkflowActionTreeNode, BaseInfo, WorkflowActionEnum
    CMS.DocumentEngineDocumentWorkflowAction
      CMS.DocumentEngineBaseDocumentAction
      CMS.DocumentEngineEmailAction
      CMS.DocumentEngineLogAction
      CMS.DocumentEngineNotificationEmailsAction
      CMS.SocialMarketingFacebookAction
      CMS.SocialMarketingLinkedInAction
      CMS.SocialMarketingTwitterAction
      CMS.TranslationServicesImportTranslationAction
      CMS.TranslationServicesSendForTranslationAction