Click or drag to resize

WorkflowBar Class
Inheritance Hierarchy

Namespace:  Kofax.OmniPageCSDK.ToolBoxes
Assembly:  Kofax.OmniPageCSDK.ToolBoxes (in Kofax.OmniPageCSDK.ToolBoxes.dll) Version: 1.0.0.0
Syntax
Copy
public class WorkflowBar : AxHost, 
	ICmnVisual, ICmnVisualUIHelper, IResourceUser, IWorkflowCreatorEvents, IWorkflowImporterEvents, 
	IWorkflowModifierEvents, IDocumentCreatorEvents, IScannerCreatorEvents, IDocumentCloserEvents, IApplicationCloserEvents, 
	IMachineCloserEvents, IResourceProviderEvents, ICmnVisualUIHelperCallbackEvents

The WorkflowBar type exposes the following members.

Constructors
  NameDescription
Public methodWorkflowBar
Initializes a new instance of the WorkflowBar class
Top
Properties
  NameDescription
Public propertyButtonWidth
Use this property to control default button width. Readable, writable property.
Public propertyCompact
Use this property to toggle WorkflowBar compact state (with or without combos).
Public propertyCompactButton
Use this property to display WorkflowBar compact button.
Public propertyMode
Use this property to change workflow processing mode (three steps or four steps).
Public propertyWorkflow
Use this property to return selected workflow file names as a string.
Top
Methods
  NameDescription
Public methodAdviseSize
Use this method to control the WorkflowBar width/height.
Public methodAttach
Use this method to attach the control to an existing document object.
Public methodAttachEngine
Use this method to attach the Engine to an existing document object.
Public methodDetach
Use this method to detach the control from an existing document object.
Public methodDetachEngine
Use this method to detach the Engine from an existing document object.
Public methodExecuteCommand(Int32)
Executes control specific command if enabled programatically.
Public methodExecuteCommand(WORKFLOWBARCOMMAND)
Use this method to force executing a WorkflowBar command.
Public methodGetCommandState(Int32, Boolean, Boolean)
Returns control specific command state as enabled or checked.
Public methodGetCommandState(WORKFLOWBARCOMMAND, Boolean, Boolean)
Use this method to request information about a WorkflowBar command.
Public methodGetIdealSize
Use this method to display each button on the WorkflowBar.
Public methodGetMenu
Returns a full menu about its own commands.
Public methodGetMenuString
Returns control specific menu string to be displayed in a menu.
Public methodGetMessageString
Returns a detailed control specific menu string to be displayed in a menu.
Public methodInt_Attach
To attach the control to an existing IPRO object.
Public methodInt_Detach
To detach the control from an existing IPRO object.
Public methodResourceAdded
Use this method to provide information on the type of resource that changed.
Public methodResourceChanged
Use this method to provide information on the change in the internal resource content.
Public methodResourceDeleted
Use this method to provide information on the deleted resource.
Public methodResourceInvalidated
Use this method to provide information on unknown resource changes.
Public methodResourceSelectionChanged
Use this method to provide information on the meaning of a selection change.
Public methodSetCommandHelpID
Pairs a help ID to each command.
Public methodSetHelpID
If set, and F1 is pressed, returns a SetHelp ID from OnSetHelp
Public methodSetUILang
Sets UI language from LANGUAGES enumeration of IPRO.
Top
Events
  NameDescription
Public eventOnAddingCommand
Provides information about adding each command to the combo; can be cancelled.
Public eventOnAdviseSize
Fired when the WorkflowBar width/height changes.
Public eventOnCloseApplication
Public eventOnCloseDocument
Public eventOnCloseMachine
Public eventOnCommandSelected
Provides information on which command is selected.
Public eventOnCreateDocument
Public eventOnCreateScanner
Public eventOnCreateWorkflow
Public eventOnEnterModal
Public eventOnGetResources
Public eventOnImportWorkflow
Public eventOnLeaveModal
Public eventOnModifyWorkflow
Public eventOnResourceChanged
Public eventOnResourceCreated
Public eventOnResourceSelectionChanged
Public eventOnSetHelp
Public eventOnSetMessageString
Public eventOnSetToolTip
Public eventOnStartingWorkflow
Fired when a workflow is launched.
Top
See Also