Click or drag to resize

DocumentCDImport Method

This method imports custom (also referred as client) data from an external file into the document.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public void CDImport(
	CD_TYPE Type,
	string Name,
	string FileName
)

Parameters

Type
Type: Kofax.OmniPageCSDK.IproPlusCD_TYPE
Name
Type: SystemString
FileName
Type: SystemString
Remarks

There are several types of data that can be managed by the document and are defined by the Type parameter. The possible types are listed under the CD_TYPE Enumeration topic.

The method reads the external file specified by the FileName parameter and stores it in the document. If the external file is corrupt or does not exist, a trappable error occurs. Custom data is identified by its name specified by the Name parameter, and its type specified by the Type parameter. If a custom data stream with the specified name and type already exists in the document, it is overwritten.

For imported CD_STRDATA type data, ANSI, UNICODE and UTF8 format text files are supported, however, once they are read, they are converted to UNICODE format. The export method always saves Unicode CD_STRDATA files.

Calling this method sets the Modified property to True.

See Also