Click or drag to resize

DocumentSetUserDictionary Method

This method selects a user dictionary for the document to use during recognition.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public void SetUserDictionary(
	string Name,
	bool Embedded,
	[OptionalAttribute] Object SectionName
)

Parameters

Name
Type: SystemString
Embedded
Type: SystemBoolean
SectionName (Optional)
Type: SystemObject
Remarks

If the Embedded parameter is True, the Name parameter specifies the name of an embedded, custom data stream of type CD_USERDICT. If the Embedded parameter is False, the Name parameter specifies a fully qualified path to a user dictionary file. If the specified user dictionary does not exist, a trappable error occurs. If this property is set to an empty string, no user dictionary is used.

The optional Section string parameter denotes the section within the user dictionary to be used. If the Section parameter is unspecified, the first available section is used automatically.

Even if a user dictionary is specified, you can still disable it at zone level by setting the DisableUserDict property of the UserZone object to True. To assign a different section to a particular zone than was specified in the SetUserDictionary method, update the UserZone object's UserDictSection property. Setting a new user dictionary on the document level resets the DisableUserDict property of all zones to an empty string.

Calling this method sets the Modified property to True.

See Also