WorkflowBar Class |
Namespace: Kofax.OmniPageCSDK.ToolBoxes
public class WorkflowBar : AxHost, ICmnVisual, ICmnVisualUIHelper, IResourceUser, IWorkflowCreatorEvents, IWorkflowImporterEvents, IWorkflowModifierEvents, IDocumentCreatorEvents, IScannerCreatorEvents, IDocumentCloserEvents, IApplicationCloserEvents, IMachineCloserEvents, IResourceProviderEvents, ICmnVisualUIHelperCallbackEvents
The WorkflowBar type exposes the following members.
Name | Description | |
---|---|---|
WorkflowBar | Initializes a new instance of the WorkflowBar class |
Name | Description | |
---|---|---|
ButtonWidth |
Use this property to control default button width. Readable, writable property.
| |
Compact |
Use this property to toggle WorkflowBar compact state (with or without combos).
| |
CompactButton |
Use this property to display WorkflowBar compact button.
| |
Mode |
Use this property to change workflow processing mode (three steps or four steps).
| |
Workflow |
Use this property to return selected workflow file names as a string.
|
Name | Description | |
---|---|---|
AdviseSize |
Use this method to control the WorkflowBar width/height.
| |
Attach |
Use this method to attach the control to an existing document object.
| |
AttachEngine |
Use this method to attach the Engine to an existing document object.
| |
Detach |
Use this method to detach the control from an existing document object.
| |
DetachEngine |
Use this method to detach the Engine from an existing document object.
| |
ExecuteCommand(Int32) |
Executes control specific command if enabled programatically.
| |
ExecuteCommand(WORKFLOWBARCOMMAND) |
Use this method to force executing a WorkflowBar command.
| |
GetCommandState(Int32, Boolean, Boolean) |
Returns control specific command state as enabled or checked.
| |
GetCommandState(WORKFLOWBARCOMMAND, Boolean, Boolean) |
Use this method to request information about a WorkflowBar command.
| |
GetIdealSize |
Use this method to display each button on the WorkflowBar.
| |
GetMenu |
Returns a full menu about its own commands.
| |
GetMenuString |
Returns control specific menu string to be displayed in a menu.
| |
GetMessageString |
Returns a detailed control specific menu string to be displayed in a menu.
| |
Int_Attach |
To attach the control to an existing IPRO object.
| |
Int_Detach |
To detach the control from an existing IPRO object.
| |
ResourceAdded |
Use this method to provide information on the type of resource that changed.
| |
ResourceChanged |
Use this method to provide information on the change in the internal resource content.
| |
ResourceDeleted |
Use this method to provide information on the deleted resource.
| |
ResourceInvalidated |
Use this method to provide information on unknown resource changes.
| |
ResourceSelectionChanged |
Use this method to provide information on the meaning of a selection change.
| |
SetCommandHelpID |
Pairs a help ID to each command.
| |
SetHelpID |
If set, and F1 is pressed, returns a SetHelp ID from OnSetHelp | |
SetUILang |
Sets UI language from LANGUAGES enumeration of IPRO.
|
Name | Description | |
---|---|---|
OnAddingCommand |
Provides information about adding each command to the combo; can be cancelled.
| |
OnAdviseSize |
Fired when the WorkflowBar width/height changes.
| |
OnCloseApplication | ||
OnCloseDocument | ||
OnCloseMachine | ||
OnCommandSelected |
Provides information on which command is selected.
| |
OnCreateDocument | ||
OnCreateScanner | ||
OnCreateWorkflow | ||
OnEnterModal | ||
OnGetResources | ||
OnImportWorkflow | ||
OnLeaveModal | ||
OnModifyWorkflow | ||
OnResourceChanged | ||
OnResourceCreated | ||
OnResourceSelectionChanged | ||
OnSetHelp | ||
OnSetMessageString | ||
OnSetToolTip | ||
OnStartingWorkflow |
Fired when a workflow is launched.
|