SettingNode Class

The SettingNode object provides access to a particular node and its setting if it exists.

Inheritance Hierarchy

SystemObject
Kofax.OmniPageCSDK.IproPlusIproPlusClass
Kofax.OmniPageCSDK.IproPlusSettingNode

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

Syntax

public class SettingNode : IproPlusClass, 
	IDisposable

Public Class SettingNode
	Inherits IproPlusClass
	Implements IDisposable

public ref class SettingNode : public IproPlusClass, 
	IDisposable

The SettingNode type exposes the following members.

Properties

	Name	Description
	ArraySize	If this node has an array setting, the property returns the size of the array.
	Count	This property returns the number of the direct child nodes.
	FullName	This property returns the absolute dot-separated path of the node.
	HasSetting	This property returns whether the node has a setting or not.
	Name	This property returns the name of the node.
	SymbolicValue	This property returns the string representation of the related setting value.
	Type	This property returns the setting type.

Methods

	Name	Description
	AddArraySetting	This method creates a new node and its setting directly under this node as a child node.
	AddBasicSetting	This method creates a new node and setting as a child node directly under the given node.
	AddEnumSetting	This method creates a new node and its setting directly under this node as a child node.
	DefaultValue	If the node does not have a setting this property returns an empty variant, otherwise it returns the default value of the setting.
	DeleteSetting	This method creates a new node and its setting directly under this node as a child node.
	Dispose	Releases all resources used by the SettingNode
	GetEnumerator
	GetEnumInfo	This method returns the available enum values and their names for an enum type setting.
	GetItem	This property returns a SettingNode object which represents a node.
	GetValue	When reading this property for node with a primitive type setting, the optional Index parameter is ignored and the value is returned.
	IsFlagSet	This property returns whether a flag for a given setting is set.
	Save	This property returns whether or not the setting will be saved when the whole tree or a sub tree is exported.
	SetToDefault	This method sets the value of the setting to its default value.
	SetToDefaultAt	Use this method to set the default value of a single node.
	SetValue	When reading this property for node with a primitive type setting, the optional Index parameter is ignored and the value is returned.

Remarks

Use this to get or set the value of a setting, retrieve information about a setting's flags and the default value, and to enumerate the child nodes.