Converters Class |
The Converters collection is a sorted set of output Converter objects.
Inheritance HierarchyNamespace: Kofax.OmniPageCSDK.IproPlus
Assembly: Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
SyntaxThe Converters type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Count |
This property returns the number of Converter objects stored in the collection.
|
Methods| Name | Description | |
|---|---|---|
 | CloneConverter |
This method creates an exact clone of an existing converter specified by the Source parameter. |
| Dispose | Releases all resources used by the Converters |
| GetEngine |
Returns the Engine object.
|
| GetEnumerator | |
| GetItem |
This property returns the requested Converter object from the collection. |
| LoadSettings |
This method loads the previously saved converter settings from an external file. |
| RemoveClonedConverter |
This method removes a cloned converter from the collection. |
| SaveSettings |
This method saves the settings of the contained converters to an external file. |
| SetDefaults |
This method resets the default settings for all converters contained by the collection.
|
Events| Name | Description | |
|---|---|---|
 | OnConverterAdded |
This event is fired when a converter is added (via cloning, for example).
|
| OnConverterRemoved |
This event is fired when a previously added converter is removed.
|
RemarksUsing its properties, the Converters collection enables information about the supported converters to be retrieved.
A converter can be "cloned" using the CloneConverter method. It makes an exact copy of the source converter and is useful to make customized converters for the same output format. The cloned converters can later be deleted using the RemoveClonedConverter method if no longer needed. Delivery ("factory") converters cannot be deleted.
See Also