DocumentWorkflowAction Class

Base document workflow action

Inheritance Hierarchy

System.Object
  CMS.WorkflowEngine.BaseWorkflowAction<TreeNode, BaseInfo, WorkflowActionEnum>
    CMS.DocumentEngine.DocumentWorkflowAction
      More...

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

Syntax

public abstract class DocumentWorkflowAction : BaseWorkflowAction<TreeNode, BaseInfo, WorkflowActionEnum>

The DocumentWorkflowAction type exposes the following members.

Constructors

	Name	Description
Protected method	DocumentWorkflowAction

Properties

	Name	Description
Public property	ActionDefinition	Action definition. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	ActionStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Arguments	Action arguments (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Comment	Comment used when action moves to next step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	InfoObject	Current info object. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	InitialStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	MacroResolver	Macro resolver for action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Manager	Manager. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected property	Node	Current document.
Public property	OriginalStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Parameters	Parameters of action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	StateObject	Current state object. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	User	User running action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Workflow	Current workflow. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected property	WorkflowManager	Workflow manager

Methods

	Name	Description
Public method Code example	Execute	Executes action. You can use parameters to allow users to modify the behavior. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected method	GetDefaultMacroResolver	Prepares macro resolver for usage. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected method	GetResolvedParameter<ReturnType>	Gets resolved value of parameter. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public method	LogMessage	Logs message to event log. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public method	Process	Processes action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected method	RefreshNode	Refreshes node instance