Click or drag to resize

ConvertersCloneConverter Method

This method creates an exact clone of an existing converter specified by the Source parameter.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public void CloneConverter(
	Converter Source,
	string Name,
	out Converter Result
)

Parameters

Source
Type: Kofax.OmniPageCSDK.IproPlusConverter
Name
Type: SystemString
Result
Type: Kofax.OmniPageCSDK.IproPlusConverter
Remarks

In other words, the source converter and all of its settings are duplicated as a new converter and added to the collection using the name specified by the Name parameter. This method is useful to make modified converters of the same type, but with a different property set. The cloned converters are automatically saved and loaded when IPRO is terminated or initialized.

The Name parameter specifies the unique name of the new converter being created. If there is a converter with the same name, a trappable error occurs. This function returns the newly created converter object.

The Cloned property of the new converter will be set to True and the Parent property will be updated to return the source converter object. The cloned converters can be destroyed using the RemoveClonedConverter method.

See Also