LEADTOOLS OCR (Leadtools.Forms.Ocr assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
IOcrUserDictionary Interface
See Also  Members  
Leadtools.Forms.Ocr Namespace : IOcrUserDictionary Interface



The user dictionary settings currently used in the engine.

Syntax

Visual Basic (Declaration) 
Public Interface IOcrUserDictionary 
Visual Basic (Usage)Copy Code
Dim instance As IOcrUserDictionary
C# 
public interface IOcrUserDictionary 
C++/CLI 
public interface class IOcrUserDictionary 

Example

This example will create a user dictionary and add a few sections and items to it

Remarks

Important Note: User dictionaries are only supported in the Advantage OCR engine in this version of LEADTOOLS. Using the functionality of the IOcrUserDictionary interface in any other engine will have no effect on the recognition results.

You can get the instance of the IOcrUserDictionary interface currently used in the engine with the IOcrSpellCheckManager.UserDictionary property.

The functionality of the checking subsystem consists of three separate parts:

  1. Spell checking through the language dictionaries. You can enable and disable the spell languages used through in the system with the IOcrSpellCheckManager.SpellLanguage property.
  2. User dictionary checking. You can control the use of a user dictionary through the IOcrUserDictionary interface methods accessed by the IOcrSpellCheckManager.UserDictionary property.
  3. User-defined checking through the use of the global OcrSpellCheckCallback callback which can be set by the IOcrSpellCheckManager.SetSpellCheckCallback method.

A user dictionary typically consists of different sections, the sections may contain one or more specified items (IOcrUserDictionaryItem). You can enumerate the sections in the User dictionary with the GetFirstSectionName and GetNextSectionName methods.

Each zone can be linked to a section in the User dictionary using the OcrZone.UserDictionarySectionName property.

User dictionary items are strings and they must be no longer than MaximumItemLength characters. They may contain spaces and punctuation characters.

If there is no default section specified, in the methods that expects a defaultSectionName parameter, the first section of the User dictionary will be the default.

You can set the current user dictionary to use in the checking subsystem with the Use method. If no user dictionary has been set, no checking through the user dictionary will be performed.

You can use the Create method to create a new user dictionary and the Open method to open for edit an existing dictionary. You can then iterate through the sections and items as well as adding new sections and items to the dictionary. When you are done, you must call Save to save any changes you made to the dictionary and finally Close to close it.

Note: The IOcrSpellCheckManager.SpellLanguage property is read only for the LEADTOOLS OCR Advantage Engine, setting this property will have no effect since the spell language will always be the same as the currently enabled language.

Note: User-defined checking through the OcrSpellCheckCallback callback is not supported when using the LEADTOOLS OCR Advantage Engine.

Note: User dictionary sections are not supported in the LEADTOOLS OCR Advantage Engine.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

IOcrUserDictionary requires an OCR module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features