Click or drag to resize

ConverterProperty Class

This object represents a single converter setting.
Inheritance Hierarchy

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public class ConverterProperty : IproPlusClass, 
	IDisposable

The ConverterProperty type exposes the following members.

Properties
  NameDescription
Public propertyCategory
This property returns the category of the specified property.
Public propertyCount
This property returns the number of children settings.
Public propertyDisplayName
This property returns the localized name of the property.
Public propertyEnabled
This property sets whether the specified property is enabled or not.
Public propertyFullName
This property returns the absolute dot-separated (.) path of the converter property.
Public propertyName
This property returns the name of the ConverterProperty.
Public propertyType
This property returns the type of the property. Its available values are listed under the PROPERTYTYPE Enumeration topic.
Public propertyValue
This property is used to get or set the value of the property.
Public propertyVisible
This property controls the visibility of the specified property.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the ConverterProperty
Public methodGetEnumerator
Public methodGetEnumValues
This property returns the ConverterEnumValues collection, which contains the available enum values if this ConverterProperty is of type PROPERTYTYPE.
Public methodGetItem
This property returns the requested ConverterProperty object, which is a child of this object.
Top
Remarks

The converter settings are represented by a hierarchical tree structure isolating the different setting groups, so that each tree node represents a converter setting which might have an associated value (and/or might have children settings). To read or manipulate a setting connected to a particular ConverterProperty object, use the Name, FullName, DisplayName, Type, Value and GetEnumValues properties. GetEnumValues returns a valid object only if the related setting is of type PROPERTY_ENUM and it can be used to query the valid enum values the particular property supports. To access the children settings of the object (if any), use the Count and the GetItem.

See Also