WorkflowAssistantDialog Class

The Workflow Control's role is to provide an easy way to create and modify OmniPage compatible workflow files that can be executed by the Document object's ExecuteWorkflow method.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsAxHost
          Kofax.OmniPageCSDK.ToolBoxesWorkflowAssistantDialog

Namespace: Kofax.OmniPageCSDK.ToolBoxes
Assembly: Kofax.OmniPageCSDK.ToolBoxes (in Kofax.OmniPageCSDK.ToolBoxes.dll) Version: 1.0.0.0

Syntax

C++

Copy

public class WorkflowAssistantDialog : AxHost, 
	ICmnVisual, IResourceProviderEvents

Public Class WorkflowAssistantDialog
	Inherits AxHost
	Implements ICmnVisual, IResourceProviderEvents

public ref class WorkflowAssistantDialog : public AxHost, 
	ICmnVisual, IResourceProviderEvents

The WorkflowAssistantDialog type exposes the following members.

Constructors

	Name	Description
	WorkflowAssistantDialog	Initializes a new instance of the WorkflowAssistantDialog class

Top

Properties

	Name	Description
	EditMode	Use this property to set or retrieve the Edit Mode of the Workflow Assistant.
	ParentWindowHandle	Use this property to set the parent window of the Workflow Assistant.
	ShowCorrectResult	This property controls whether or not the Correct Recognition Result step is enabled when creating a new workflow.
	ShowEnhanceImages	This property controls whether or not the Enhance Images step is enabled when creating a new workflow.
	ShowExtractFormData	This property controls whether or not the Extract Form Data step is enabled when creating a new workflow.
	ShowLoadDigitalCameraFiles	This property controls whether or not the Load Digital Camera Files step is enabled when creating a new workflow.
	ShowLoadFiles	This property controls whether or not the Load Files step is enabled when creating a new workflow.
	ShowLoadFromDropbox	This property controls whether or not the Load From Dropbox step is enabled when creating a new workflow.
	ShowLoadFromEvernote	This property controls whether or not the Load From Evernote step is enabled when creating a new workflow.
	ShowLoadFromFTP	This property controls whether or not the Load from FTP step is enabled when creating a new workflow.
	ShowLoadFromLotusNotes	This property controls whether or not the Load From Lotus Notes step is enabled when creating a new workflow.
	ShowLoadFromODMA	This property controls whether or not the Load from ODMA step is enabled when creating a new workflow.
	ShowLoadFromSharePoint	This property controls whether or not the Load from SharePoint step is enabled when creating a new workflow.
	ShowMarkText	This property controls whether or not the Mark Text step is enabled when creating a new workflow.
	ShowOpenOPD	This property controls whether or not the Open OPD (OmniPage Document) step is enabled when creating a new workflow.
	ShowRecognize	This property controls whether or not the Recognize step is enabled when creating a new workflow.
	ShowSave	This property controls whether or not the Save step is enabled when creating a new workflow.
	ShowSaveAsOPD	This property controls whether or not the Save as OPD (OmniPage Document) step is enabled when creating a new workflow.
	ShowSaveToClipboard	This property controls whether or not the Save to Clipboard step is enabled when creating a new workflow.
	ShowSaveToDropbox	This property controls whether or not the Save to Dropbox step is enabled when creating a new workflow.
	ShowSaveToEvernote	This property controls whether or not the Save to Evernote step is enabled when creating a new workflow.
	ShowSaveToFTP	This property controls whether or not the Save to FTP step is enabled when creating a new workflow.
	ShowSaveToODMA	This property controls whether or not the Save to ODMA step is enabled when creating a new workflow.
	ShowSaveToSharePoint	This property controls whether or not the Save to SharePoint step is enabled when creating a new workflow.
	ShowScanImages	This property controls whether or not the Scan Images step is enabled when creating a new workflow.
	ShowSendInMail	This property controls whether or not the Send in Mail step is enabled when creating a new workflow.
	ShowZoneImages	This property controls whether or not the Zone Images step is enabled when creating a new workflow.

Top

Methods

	Name	Description
	Attach	Use this method to attach the control to the initialized Engine object.
	CreateWorkflow	Call this method to create a new workflow file.
	Detach	Use this method to detach the control from the Engine.
	Int_Attach	To attach the control to an existing IPRO object.
	Int_Detach	To detach the control from an existing IPRO object.
	ModifyWorkflow	Call this method to modify an existing workflow file.
	ModifyWorkflowEx	Call this method to modify an existing workflow file.

Top

Events

	Name	Description
	OnEnterModal	Places a modal window in an application.
	OnGetResources
	OnLeaveModal	Program is not modal anymore.
	OnResourceChanged
	OnResourceCreated
	OnResourceSelectionChanged
	OnSetHelp	Returned when F1 is pressed over a menu command.
	OnSetMessageString	Sets a detailed control specific menu string to be displayed in a menu.
	OnSetToolTip	Rewritable string to be displayed as a tooltip.

Top

Remarks

A workflow consists of a series of steps and their settings. Typically it will include a recognition step, but it does not have to. Workflows allow recurring tasks to be handled more efficiently, because all the steps and settings are pre-defined. To check out the complete list of available steps, see the Station Summary part under Workflow Viewer Control section.

Once the control is involved, an easy-to-use wizard interface is displayed which allows workflow steps to be defined along with the parameters for each step. When a new workflow is being created, or an existing workflow is being modified, a set of WFC properties give control over which steps will be offered by the wizard - this is step filtering. It allows steps to be discarded which the application or the current workflow should not be allowed to offer. In addition to step filtering, the workflow handler will only offer steps which it deems to be logically reasonable at a given place in the workflow.

If the control is used to modify an existing workflow, all the workflow steps within the workflow will automatically be displayed, regardless of step filtering settings. However, only permitted steps will be available for modifying the workflow.

Parameters for steps can be modified freely without impacting the workflow step structure. However, if steps are added, deleted or re-arranged, other dependent, subsequent steps may be removed and must be restored to suit the needs of the modified workflow.

In version 16, step selection and parameter pages appear on a single screen:

On the right, settings for the current workflow step (load files) are displayed.

The list on the left shows all unfiltered and logically permitted steps for the current workflow position.

Reference

Kofax.OmniPageCSDK.ToolBoxes Namespace