Converter Class

The Converter object provides properties and methods to customize the layout of the output files created by the Document and Page objects' ConvertResult method.

Inheritance Hierarchy

SystemObject
Kofax.OmniPageCSDK.IproPlusIproPlusClass
Kofax.OmniPageCSDK.IproPlusConverter

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

Syntax

C++

Copy

public class Converter : IproPlusClass, IDisposable

Public Class Converter
	Inherits IproPlusClass
	Implements IDisposable

public ref class Converter : public IproPlusClass, 
	IDisposable

The Converter type exposes the following members.

Properties

	Name	Description
	Cloned	This property returns True if the particular converter is a cloned converter.
	Count	This property returns the number of ConverterProperty children objects of this object.
	DisplayName	This property returns the localized converter name. Available English values are listed under the Name property.
	Extension	This property returns the associated extension which should be used when creating an output file with the particular converter.
	FileOption	This property is used to get or set the file creation mode to be used during the output conversion.
	FormattingLevel	This property is used to get or set the formatting level of the text converter.
	Item	This property is used to get or set a property of the converter.
	Name	This property returns the unique, identifying name of the converter.

Top

Methods

	Name	Description
	CloneAt	Use this method if you want to modify the settings of a given Converter in the context of the target SettingManager.
	CopyFrom	This method is used to copy the current values of the named Converter's settings from the source SettingManager.
	CopyTo	This method is used to copy the current values of the Converter's settings to the target SettingManager.
	Dispose	Releases all resources used by the Converter
	GetChildConverters	This method is used to get the child converters of a specific converter.
	GetEngine	Returns the Engine object.
	GetEnumerator
	GetParent	This property returns the parent converter object of a cloned converter.
	Item	This property returns the requested ConverterProperty object, which represents a setting node in the converter property tree.
	LoadSettings	This method loads the converter settings from a previously saved external setting file.
	SaveSettings	This method saves the settings of the particular converter into an external file.
	SetChildConverters	This method is used to set the child converters of a specific converter.
	SetDefaults	This method restores the delivery ("factory") settings of the particular converter.

Top

Remarks

The converter settings are organized into a tree-structure, and they are available through the ConverterProperty object, which represent a setting node in the tree.

There are four types of converters:

text converters: create a (formatted or unformatted text file from the recognition results
image converters: create image files from the input images, they do not require the input pages to be recognized
multiple converters: combination of text and/or image converters and they create multiple output files when exporting
form converters: used in form data extraction

There is a multitude of possibilities to set converter parameters. Use ConverterProperty to customize them. To query them, use the GetItem method of the Converters collection. Converter names and parameter setting possibilities are detailed in the RecAPI documentation under List of all Converter settings of RecAPI.

Reference

Kofax.OmniPageCSDK.IproPlus Namespace