IWorkflowAdvance Method

Advances this workflow from its current Work State to the next Work State, using a specified Transition. Meanwhile, determines which User to whom to assign the workflow, and whether to perform Actions.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492

Syntax

C++

Copy

void Advance(
	ITransition transition,
	string comment,
	IUser assignUser = null,
	bool performAction = true,
	bool groupAssign = false,
	bool skipEmail = false
)

Sub Advance ( 
	transition As ITransition,
	comment As String,
	Optional assignUser As IUser = Nothing,
	Optional performAction As Boolean = true,
	Optional groupAssign As Boolean = false,
	Optional skipEmail As Boolean = false
)

void Advance(
	ITransition^ transition, 
	String^ comment, 
	IUser^ assignUser = nullptr, 
	bool performAction = true, 
	bool groupAssign = false, 
	bool skipEmail = false
)

abstract Advance : 
        transition : ITransition * 
        comment : string * 
        ?assignUser : IUser * 
        ?performAction : bool * 
        ?groupAssign : bool * 
        ?skipEmail : bool 
(* Defaults:
        let _assignUser = defaultArg assignUser null
        let _performAction = defaultArg performAction true
        let _groupAssign = defaultArg groupAssign false
        let _skipEmail = defaultArg skipEmail false
*)
-> unit

Parameters

transition ITransition: The transition that is used to advance the workflow, the next Work State of this workflow will be the NextState on the transition.
comment String: User comments on the advancement
assignUser IUser (Optional): The user to whom to assign the page. If default, assign to the DefaultUser of the transition, or the NextGroup on the transition if DefaultUser is not specified.
performAction Boolean (Optional): Specifies whether to perform the actions on the transition. Defaults to true.
groupAssign Boolean (Optional): Specifies whether to assign page to next group if no user is provided. If false it will choose the default user if possible before resorting to group. Defaults to false.
skipEmail Boolean (Optional): Skip sending email notifications during workflow advance. Defaults to false.

Exceptions

Exception	Condition
InvalidOperationException	When workflow is locked

Remarks

If the Workflow's DontExecuteActions property is set to true, the performAction parameter will not be effective.

Reference

IWorkflow Interface

Ingeniux.CMS Namespace