WFHandler Class |
The WFHandler object contains a wide range of workflow handling functionality.
Inheritance HierarchyNamespace: OmniPageCSDK.IproPlus
Assembly: OmniPageCSDK.IproPlus (in OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
SyntaxThe WFHandler type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Running |
This property checks whether the WFHandler is currently running a workflow. |
| WFHOption |
This property returns the list of available workflow handler options.
|
| WindowHandle |
This property can be used to set a specific handle for the opening dialog boxes to use as a parent window.
|
Methods| Name | Description | |
|---|---|---|
 | AddPageByIndex |
Use this method to add an existing page of the Document to the workflow.
|
| AddPagesByState |
This method is used to add document pages to the newly created workflow. |
| AddWFInput |
Use this method to add an input object to the workflow. |
| AddWFOutput |
This method is used to specify the output file name and output file type for the export step (type IWFT_EXPORT) in the workflow. |
| ClearTempParams |
Use this method to clear the temporary parameter set. |
| CreateNewWF | This API is preliminary and subject to change. |
| CreateWF |
This method is used to start the creation of an instant workflow. |
| Dispose | Releases all resources used by the WFHandler |
| FinalizeWF |
Use this method to finalize the instant workflow you have just created with the CreateWF method. |
| GetTempParam |
This method is used to get the value of a temporary parameter that was set earlier by SetTempParam. |
| GetWFDescInfo |
Use this property to acquire the workflow static information provider interface.
|
| GetWFParam |
Use this method to query the specified workflow parameter identified by its Name. |
| GetWFProcInfo |
Use this property to acquire the workflow dynamic / runtime information provider interface.
|
| GetWFProgress |
Object without methods, can only fire events from workflow progress.
|
| LoadWF |
This method is used to load a workflow stored in the workflow file that is specified in the wfFileName parameter. |
| PauseWorkflow |
Use this method to pause the currently running user-defined workflow. |
| QueryStepSupport |
This property returns whether a specific workflow step is supported.
|
| RemoveAllWFObjects |
Use this method to remove all objects from a specific workflow. |
| SaveWF |
This method is used to save the specified workflow if its origin is not WO_INSTANT.
|
| SetTempParam |
This method is used to set the Value of a temporary workflow parameter identified with its Name. |
| SetWFParam |
This method is used to set the Value of the workflow parameter identified by its Name. |
| StartWorkflow |
Use this method to start the current workflow. |
| StopWorkflow |
This method is used to stop the currently running workflow. |
| UIStepIntervention |
Use this method to specify how the current interactive user step should process the current and remaining pages in the workflow.
See UISTEP_IVMODE.
|
Events| Name | Description | |
|---|---|---|
 | OnEnterInteractiveMode |
This event is fired when the workflow must start communication with the user via a dialog window.
|
| OnLeaveInteractiveMode |
This event is fired when the interactive mode (the dialog window) is closed.
|
| OnNewWorkflowObject |
This event is fired when a new workflow object is introduced.
|
| OnWorkflowBegin |
This event is fired when a workflow is started.
|
| OnWorkflowEnd |
This event is fired when a workflow ends.
|
| OnWorkflowInfo |
This event is fired when the information attributes of a workflow are changed.
|
| OnWorkflowStateChanged |
This event is fired when the state of a workflow changes.
|
RemarksIts two main purposes are:
- running existing workflows created with the Workflow Assistant
- programmatically compiling and running workflows
In either case, you can specify parameters for individual workflow steps. In addition to the traditional steps (loading, scanning, recognizing, exporting, etc) the current application version has new ones including Form Data Extraction and Text Marking steps.
To query dynamic (execution state) or static (origin, friendly and full file name, etc) workflow information you can also use WFProcInfo and WFDescInfo provided by this object.
See Also