Click or drag to resize

WFHandler Class
This property returns the workflow handler interface.
Inheritance Hierarchy

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
Copy
public class WFHandler : IproPlusClass, IDisposable

The WFHandler type exposes the following members.

Properties
  NameDescription
Public propertyRunning
This property checks whether the WFHandler is currently running a workflow.
Public propertyWFHOption
This property returns the list of available workflow handler options.
Public propertyWindowHandle
This property can be used to set a specific handle for the opening dialog boxes to use as a parent window.
Top
Methods
  NameDescription
Public methodAddPageByIndex
Use this method to add an existing page of the Document to the workflow.
Public methodAddPagesByState
This method is used to add document pages to the newly created workflow.
Public methodAddWFInput
Use this method to add an input object to the workflow.
Public methodAddWFOutput
This method is used to specify the output file name and output file type for the export step (type IWFT_EXPORT) in the workflow.
Public methodClearTempParams
Use this method to clear the temporary parameter set.
Public methodCreateNewWF
This API is preliminary and subject to change.
Public methodCreateWF
This method is used to start the creation of an instant workflow.
Public methodDispose
Releases all resources used by the WFHandler
Public methodFinalizeWF
Use this method to finalize the instant workflow you have just created with the CreateWF method.
Public methodGetTempParam
This method is used to get the value of a temporary parameter that was set earlier by SetTempParam.
Public methodGetWFDescInfo
Use this property to acquire the workflow static information provider interface.
Public methodGetWFParam
Use this method to query the specified workflow parameter identified by its Name.
Public methodGetWFProcInfo
Use this property to acquire the workflow dynamic / runtime information provider interface.
Public methodGetWFProgress
Object without methods, can only fire events from workflow progress.
Public methodLoadWF
This method is used to load a workflow stored in the workflow file that is specified in the wfFileName parameter.
Public methodPauseWorkflow
Use this method to pause the currently running user-defined workflow.
Public methodQueryStepSupport
This property returns whether a specific workflow step is supported.
Public methodRemoveAllWFObjects
Use this method to remove all objects from a specific workflow.
Public methodSaveWF
This method is used to save the specified workflow if its origin is not WO_INSTANT.
Public methodSetTempParam
This method is used to set the Value of a temporary workflow parameter identified with its Name.
Public methodSetWFParam
This method is used to set the Value of the workflow parameter identified by its Name.
Public methodStartWorkflow
Use this method to start the current workflow.
Public methodStopWorkflow
This method is used to stop the currently running workflow.
Public methodUIStepIntervention
Use this method to specify how the current interactive user step should process the current and remaining pages in the workflow. See UISTEP_IVMODE.
Top
Events
  NameDescription
Public eventOnEnterInteractiveMode
This event is fired when the workflow must start communication with the user via a dialog window.
Public eventOnLeaveInteractiveMode
This event is fired when the interactive mode (the dialog window) is closed.
Public eventOnNewWorkflowObject
This event is fired when a new workflow object is introduced.
Public eventOnWorkflowBegin
This event is fired when a workflow is started.
Public eventOnWorkflowEnd
This event is fired when a workflow ends.
Public eventOnWorkflowInfo
This event is fired when the information attributes of a workflow are changed.
Public eventOnWorkflowStateChanged
This event is fired when the state of a workflow changes.
Top
See Also