Click or drag to resize

IWorkflowManagerRemoveWorkState Method

Removes a Work State from the collection.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax
Copy
bool RemoveWorkState(
	IWorkState workState
)

Parameters

workState
Type: Ingeniux.CMSIWorkState
The workstate to remove

Return Value

Type: Boolean
True if the workstate exists in collection, false otherwise.
Exceptions
ExceptionCondition
InvalidOperationExceptionWhen workstate's name is "Initial", or workstate is still being used in transitions of any workflow definitions.
Remarks

If the workstate's name is "Initial" or the workstate is being used in Transitions of any Workflow defintions, it cannot be deleted.

See Also