Workflows class

Parent Previous Next

The Workflows object specifies a collection of loaded workflow objects. An instance of the Workflows collection is provided by the Session object.


Namespace:

IYOPRO.Api

Assembly:

IYOPRO.Api (in IYOPRO.Api.dll)


Syntax

       class Workflows()


Members

void Load(int wfid,object userdata = null)

Retrieves a Workflow definition.

Wfid specifies the id of the workflow.

Userdata will be provided in the WorkflowLoadedEventEventArgs

void Load(string tag, object userdata = null)

Retrieves a Workflow definition.

Userdata will be provided in the WorkflowsLoadedEventEventArgs

void LoadStartForm(int wfid, object userdata = null)

Retrieves a Workflow definition.

Wfid specifies the id of the workflow.

Userdata will be provided in the WorkflowFormLoadedEventEventArgs

event WorkflowLoadedEvent WorkflowLoaded

The WorkflowLoaded event is triggered if the Load method has finished

event WorkflowsLoadedEvent WorkflowsLoaded

The WorkflowsLoaded event is triggered if the Load method has finished

event WorkflowFormLoadedEvent WorkflowFormLoaded

The WorkflowFormLoaded event is triggered if the Load method has finished



Sample



// Load Workflow definition

Workflows wf = session.Workflows;


Workflows.WorkflowLoadedEvent handler = null;

handler = (s, args) =>

{

wf.WorkflowLoaded -= handler;

Workflow w = args.Workflow;

if (w == null) return;

};

wf.WorkflowLoaded += handler;

wf.Load(workflowid);