SettingView Class |
 Caution |
|---|
This API is preliminary and subject to change.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
System.Windows.FormsAxHost
Kofax.OmniPageCSDK.ToolBoxesSettingView
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
System.Windows.FormsAxHost
Kofax.OmniPageCSDK.ToolBoxesSettingView
Namespace: Kofax.OmniPageCSDK.ToolBoxes
Assembly: Kofax.OmniPageCSDK.ToolBoxes (in Kofax.OmniPageCSDK.ToolBoxes.dll) Version: 1.0.0.0
SyntaxThe SettingView type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SettingView | Initializes a new instance of the SettingView class |
Properties| Name | Description | |
|---|---|---|
 | BorderVisible |
Use this method to draw a border around the SettingView control.
|
| Hexadecimal |
Use this method to display SettingView control values in hexadecimal.
|
| Root |
Use this method to display a root treeview section name; if empty, the full treeview is displayed.
|
| ShowHiddens |
Use this method to display hidden setting names.
|
| ShowNumericEnums |
Use this method to display setting enumeration integer values besides their names.
|
| UserShowHiddens |
If true, context menu show/hide hidden setting options become available.
|
Methods| Name | Description | |
|---|---|---|
| Attach |
Use this method to attach the control to an existing document object.
|
| Detach |
Use this method to detach the control from an existing document object.
|
| ExecuteCommand(Int32) |
Executes control specific command if enabled programatically.
|
| ExecuteCommand(SETTINGVIEWCOMMAND) |
Use this method to force executing a SettingView command.
|
| GetCommandState(Int32, Boolean, Boolean) |
Returns control specific command state as enabled or checked.
|
| GetCommandState(SETTINGVIEWCOMMAND, Boolean, Boolean) |
Use this method to request information about a SettingView 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.
|
| 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 | |
|---|---|---|
 | OnAddNode |
Fired when the setting nodes are added to the treeview. Official name and display name can be overridden.
|
| OnEnterModal | |
| OnInputError |
Fired when incorrect input is provided as a setting value (e.g. letter instead of number)
|
| OnLeaveModal | |
| OnSetHelp | |
| OnSetMessageString | |
| OnSetToolTip | |
| OnTranslateValues |
Fired to modify display name of enum values: changing text, translating to other languages, and so on.
|
See Also