BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType> Class

General base class for workflow actions.

Inheritance Hierarchy

System.Object
  CMS.WorkflowEngine.BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>
    CMS.Automation.AutomationAction
    CMS.DocumentEngine.DocumentWorkflowAction

Namespace: CMS.WorkflowEngine
Assembly: CMS.WorkflowEngine (in CMS.WorkflowEngine.dll) Version: 8.2.23

Syntax

public abstract class BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType> : IWorkflowAction
where InfoType : BaseInfo
where StateInfoType : BaseInfo
where ActionEnumType : struct, new(), IConvertible

Type Parameters

InfoType

StateInfoType

ActionEnumType

The BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType> type exposes the following members.

Constructors

	Name	Description
Protected method	BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>

Methods

	Name	Description
Public method Code example	Execute	Executes action. You can use parameters to allow users to modify the behavior.
Protected method	GetDefaultMacroResolver	Prepares macro resolver for usage.
Protected method	GetResolvedParameter<ReturnType>	Gets resolved value of parameter.
Public method	LogMessage	Logs message to event log.
Public method	Process	Processes action.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	ActionDefinition	Action definition.
Public property	ActionStep	Current step.
Public property	Arguments	Action arguments
Public property	Comment	Comment used when action moves to next step.
Public property	InfoObject	Current info object.
Public property	InitialStep	Current step.
Public property	MacroResolver	Macro resolver for action.
Public property	Manager	Manager.
Public property	OriginalStep	Current step.
Public property	Parameters	Parameters of action.
Public property	StateObject	Current state object.
Public property	User	User running action.
Public property	Workflow	Current workflow.