WorkflowView Class |
The WFVC control can be used either to display workflow processing results, or to visualize workflow execution progress information.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
System.Windows.FormsAxHost
Kofax.OmniPageCSDK.ToolBoxesWorkflowView
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
System.Windows.FormsAxHost
Kofax.OmniPageCSDK.ToolBoxesWorkflowView
Namespace: Kofax.OmniPageCSDK.ToolBoxes
Assembly: Kofax.OmniPageCSDK.ToolBoxes (in Kofax.OmniPageCSDK.ToolBoxes.dll) Version: 1.0.0.0
SyntaxThe WorkflowView type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WorkflowView | Initializes a new instance of the WorkflowView class |
Properties| Name | Description | |
|---|---|---|
 | ArrowClr |
This property controls the drawing color of the arrows that appear between neighboring stations. |
| BorderVisible |
This property controls whether a thin 3D border will be displayed around the control or not. |
| ElasticStations |
When this property is True, and the control dimensions are larger than the space required to draw the current station sequence using the default station size,
the station width (in horizontal station modes) or height (in vertical station modes) will be automatically expanded to fit into the current control space. |
| GridLineClr |
This property controls the drawing color of the grid visible in mixed mode. |
| ObjectProgressClr |
This property controls the base color of the gradient filled objects' progress indication in mixed mode. |
| ObjectProgressTextClr |
This property controls the drawing color of the objects' progress text in mixed mode. |
| ObjectTextClr |
This property controls the drawing color of the objects' text in mixed mode. |
| ProcessObjectEvents |
This property controls whether object events will be processed and reported or ignored when a workflow is being executed. |
| SelectedObjectTextClr |
This property controls the drawing color of the selected objects' text in mixed mode. |
| StationCount |
This property returns the number of stations currently contained by the control.
|
| StationHeight |
This property returns the height of stations drawn by the control. |
| StationPipeClr |
This property controls the drawing color of the pipes displayed in mixed mode. |
| StationProgressClr |
This property controls the base color of the gradient filled stations' progress indicating. |
| StationProgressTextClr |
This property controls the drawing color of the stations' progress text. |
| StationTextClr |
This property controls the drawing color of the stations' label text. |
| StationWidth |
This property returns the width of stations drawn by the control. |
| TabStop |
This property controls whether or not the user can give the focus to this control using the Tab key. |
| TooltipBKClr |
This property controls the drawing color of the appearing info tips' background.
|
| TooltipTextClr |
This property controls the drawing color of the appearing info tips' text. |
| ViewBKClr |
This property controls the drawing color of the control's background. |
| ViewerMode |
This property controls the working mode of the control. |
| WorkflowHeight |
This property returns the height of the area requested to draw all stations. |
| WorkflowWidth |
This property returns the width of the area requested to draw all stations. |
Methods| Name | Description | |
|---|---|---|
| Attach |
Use this method to attach the control to an existing document object. |
| Clear |
This method clears the workflow description from the control and removes all the visualized objects. |
| CollapseAllNodes |
This method collapses all object nodes. |
| Detach |
Use this method to detach the control from an existing document. |
| EnsureStationVisible |
Call this function to ensure that a specified station is visible. |
| ExpandAllNodes |
This method expands all object nodes. |
| HitTest |
Use this function in conjunction with the mouse events detailed in the Events section. |
| Int_Attach |
To attach the control to an existing IPRO object.
|
| Int_Detach |
To detach the control from an existing IPRO object.
|
| PopupToolTip |
This method forces the display of an information tip on particular objects if available. |
| QueryNodeInfo |
You can use this function to get extra information on a particular item if available. |
| Reload |
This method reloads the last workflow result from the attached document and displays it in the control. |
| SetDefaultColors |
Call this function to restore the default drawing colors of the control you might have customized. |
| ToggleNode |
This method collapses or expands a particular object. |
| UpdateCtrl |
Call this method to force redrawing of the entire control.
|
Events| Name | Description | |
|---|---|---|
 | OnKeyPressed |
This event is fired when there is an active item and the user presses or releases a key on the keyboard. |
| OnObjectClicked |
This event is fired whenever an object is clicked in the viewer: x and y contain mouse pointer coordinates. |
| OnStationClicked |
This event is fired whenever a station is clicked in the viewer: x and y contain mouse pointer coordinates. |
| OnViewerModeChanged |
This event is fired when the current viewer mode has changed. |
| OnWorkflowChanged |
This event is fired when the workflow connected to a document is replaced by a different one. |
Remarks
In either case, the control always displays document-related workflow information.
Remarks
The viewer contains two kinds of components: stations and objects. The station is the place where the objects are processed. Each workflow contains a series of stations,
each processing particular types of objects. Additionally to this progress indication information, a set of useful information items can be displayed in tooltip windows
when the mouse is hovered over workflow objects.
Remarks
This shows the control appearance in mixed mode with horizontal arrangement for stations including the station labels:
See Also