SettingManager Class |
Inheritance HierarchyNamespace: OmniPageCSDK.IproPlus
Assembly: OmniPageCSDK.IproPlus (in OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
SyntaxThe SettingManager type exposes the following members.
Properties
Methods| Name | Description | |
|---|---|---|
 | AddArraySetting |
This method creates and returns a new node with an array type setting. |
| AddBasicSetting |
This method creates and returns a new node with a primitive setting. |
| AddEnumSetting |
This method creates and returns a new node with an enumerated setting. |
| Clone |
This method is used to create an exact copy of the called SettingManager object. |
| CopySetting |
The CopySetting method is used to copy a setting, a subtree or the full tree to another SettingManager. |
| DefaultSettingValue |
This property gets or returns the default value of a given setting.
|
| DeleteSetting |
This method deletes a node or its whole sub-tree from the setting tree. |
| Dispose | Releases all resources used by the SettingManager |
| GetDocument |
Returns the parent Document object.
|
| GetEngine |
Returns the Engine object.
|
| GetEnumerator | |
| GetItem |
This property returns a SettingNode object, which represents a node. |
| GetSettingValue |
This property returns or sets the value of a setting. |
| Load |
Calling this method loads the values stored in the specified file. |
| Save |
Calling this method saves the entire setting tree to the specified file. |
| SetDefaults |
Calling this method sets the values of all settings to their default value. |
| SetSettingValue |
This property returns or sets the value of a setting. |
RemarksSettings are named values which control the behavior of different functions on the lower levels of the SDK. They are organized in a tree structure. The setting tree contains a large number of settings, but you should only manipulate the ones by the SettingManager which are documented in the RecAPI help.
In a setting tree, every setting is attached to a node. (The nodes do not necessarily have associated setting values. For example, some nodes might be created to act as the parent of a set of child nodes having associated setting values.) Individual settings are unambiguously identified by their "path" name, which is made up by concatenating the names of the nodes from the root node down to the setting node. The node names are separated by dots.
Several setting trees can co-exist at a time. Upon its creation, the Engine creates the first setting tree. All other setting trees are created as copies of the current settings of the Engine. Each newly created Document receives such a copy of the Engine's settings. This way the settings of the individual documents are independent of each other and also from the settings of the Engine.
When a document is saved to an OPD file, the current Document settings are also saved automatically. However, you should explicitly save the Engine settings if needed.
Each SettingManager is able to clone itself with its Clone method. The returned clone is an exact copy of the original and is independent of any other SettingManager objects. This is useful if you want to enable setting modifications on the UI without making changes to the original ones. Once the new settings are accepted, they can be copied back to the source SettingManager.
Scanner and Converter object settings present special cases. Although they do appear in setting trees, several of their individual setting values may depend on others. Therefore we suggest that you work with Scanner and Converter object settings via these objects themselves, and not by utilizing the SettingManager.
Scanner and Converter objects can be queried only from the Engine. These objects will modify the settings of the Engine. For document-specific Scanner and Converter setting modification these objects provide some helper methods. To let document-specific Scanner and Converter settings have an effect in your workflows, you must set the SP_EXP_USEENGINECONVERTERS and SP_EXP_USEENGINESSCANNERS workflow step parameters to false.
The setting manager supports the following setting types: integer, floating point, Boolean, string, integer array, floating point array, Boolean array and enumerated. Saving and loading the entire setting tree, or any sub-tree is also supported.
See Also