SettingManager Class

This property returns the SettingManager object, which allows you to manage your application-specific settings together with the Engine settings in a thread-safe manner.

Inheritance Hierarchy

SystemObject
Kofax.OmniPageCSDK.IproPlusIproPlusClass
Kofax.OmniPageCSDK.IproPlusSettingManager

Namespace: Kofax.OmniPageCSDK.IproPlus
Assembly: Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0

Syntax

C++

Copy

public class SettingManager : IproPlusClass, 
	IDisposable

Public Class SettingManager
	Inherits IproPlusClass
	Implements IDisposable

public ref class SettingManager : public IproPlusClass, 
	IDisposable

The SettingManager type exposes the following members.

Properties

	Name	Description
	Count	This property returns the number of first-level nodes.

Top

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.

Top

Remarks

If the Engine is not initialized, accessing this property will raise a trappable error.

Reference

Kofax.OmniPageCSDK.IproPlus Namespace