ConverterView Class |
 Caution |
|---|
This API is preliminary and subject to change.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
System.Windows.FormsAxHost
Kofax.OmniPageCSDK.ToolBoxesConverterView
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
System.Windows.FormsAxHost
Kofax.OmniPageCSDK.ToolBoxesConverterView
Namespace: Kofax.OmniPageCSDK.ToolBoxes
Assembly: Kofax.OmniPageCSDK.ToolBoxes (in Kofax.OmniPageCSDK.ToolBoxes.dll) Version: 1.0.0.0
SyntaxThe ConverterView type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ConverterView | Initializes a new instance of the ConverterView class |
Properties| Name | Description | |||
|---|---|---|---|---|
 | BorderVisible |
Use this method to draw border around a control.
| ||
| Dirty |
Use this method to display any user made changes in settings.
| ||
| IncludeStandardProperties |
To display the standard properties.
| ||
| RawView |
This API is preliminary and subject to change. |
Methods| Name | Description | |
|---|---|---|
| Attach |
To attach the control to an existing converter object.
|
| Detach |
Use this method to detach the control from an existing converter.
|
| ExecuteCommand(Int32) |
Executes control specific command if enabled programatically.
|
| ExecuteCommand(CONVERTERVIEWCOMMAND) |
To force executing a ConverterView command.
|
| GetCommandState(Int32, Boolean, Boolean) |
Returns control specific command state as enabled or checked.
|
| GetCommandState(CONVERTERVIEWCOMMAND, Boolean, Boolean) |
To request information about a ConverterView command.
|
| 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.
|
| Renew |
To synchronize converter property displayed state with its current state.
|
| Reset |
To reset command state to the original, when no user modification is done.
|
| 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.
|
Events| Name | Description | |
|---|---|---|
 | OnEnterModal | |
| OnLeaveModal | |
| OnModified |
Fired when user modified any setting whose state can be changed (dirty).
|
| OnResetApplied |
Fired when user sets default converter parameter back.
|
| OnSetHelp | |
| OnSetMessageString | |
| OnSetToolTip |
See Also