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



sectionName
Name of the section where the items are retrieved.

Note: This parameter is not supported in the LEADTOOLS OCR Advantage Engine and it should be null.

The GetFirstItem Method is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

sectionName
Name of the section where the items are retrieved.

Note: This parameter is not supported in the LEADTOOLS OCR Advantage Engine and it should be null.

Gets the first section item in the currently opened user dictionary.

Syntax

Visual Basic (Declaration) 
Function GetFirstItem( _
   ByVal sectionName As String _
) As IOcrUserDictionaryItem
Visual Basic (Usage)Copy Code
Dim instance As IOcrUserDictionary
Dim sectionName As String
Dim value As IOcrUserDictionaryItem
 
value = instance.GetFirstItem(sectionName)
C# 
IOcrUserDictionaryItem GetFirstItem( 
   string sectionName
)
C++/CLI 
IOcrUserDictionaryItem^ GetFirstItem( 
   String^ sectionName
) 

Parameters

sectionName
Name of the section where the items are retrieved.

Note: This parameter is not supported in the LEADTOOLS OCR Advantage Engine and it should be null.

Return Value

The first item in the section or null (Nothing in Visual Basic) if no more items are found.

Example

For an example, refer to IOcrUserDictionary.

Remarks

The user dictionary must be opened with Open or Create before you can use this method.

The method might return a group of items separated with a comma.

Refer to IOcrUserDictionary example on how to use this method to iterate the user dictionary items.

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.

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

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