Click or drag to resize

UDManagerOpen Method

This method opens an existing user dictionary for maintenance.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public void Open(
	string UDName,
	[OptionalAttribute] Document Document
)

Parameters

UDName
Type: SystemString
Document (Optional)
Type: Kofax.OmniPageCSDK.IproPlusDocument
Remarks

The user dictionary can either be stored in a separate file or can be embedded into a Document object. For stand-alone dictionaries the UDName parameter is the fully qualified path to the dictionary file and the optional Document parameter is ignored. With embedded dictionaries, the UDName parameter is the name of the dictionary embedded into the Document object specified by the Document parameter.

If the specified user dictionary does not exist, a trappable error occurs. If a user dictionary is already open, a trappable error occurs. If the Open call succeeds, the IsDirty flag is cleared and the Name property is updated accordingly.

See Also