Leadtools.Forms.Auto Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
RecognizeForm(String,Generic List) Method
See Also 
Leadtools.Forms.Auto Namespace > AutoFormsEngine Class > RecognizeForm Method : RecognizeForm(String,Generic List) Method



fileName
A String containing the name of the unknown form image file.
categories
List of Master Forms categories to use in comaprison, pass null or empty to use all Master Forms in the repository.
fileName
A String containing the name of the unknown form image file.
categories
List of Master Forms categories to use in comaprison, pass null or empty to use all Master Forms in the repository.
Recognize the Form type.

Syntax

Visual Basic (Declaration) 
Overloads Public Function RecognizeForm( _
   ByVal fileName As String, _
   ByVal categories As List(Of IMasterFormsCategory) _
) As AutoFormsRecognizeFormResult
Visual Basic (Usage)Copy Code
Dim instance As AutoFormsEngine
Dim fileName As String
Dim categories As List(Of IMasterFormsCategory)
Dim value As AutoFormsRecognizeFormResult
 
value = instance.RecognizeForm(fileName, categories)
C++/CLI 
public:
AutoFormsRecognizeFormResult^ RecognizeForm( 
   String^ fileName,
   List<IMasterFormsCategory>^ categories
) 

Parameters

fileName
A String containing the name of the unknown form image file.
categories
List of Master Forms categories to use in comaprison, pass null or empty to use all Master Forms in the repository.

Return Value

The result of the recognition will be the result of the Master Form with maximum confidence. If the confidence is less than MinimumConfidenceKnownForm it will return null, i.e. the form type is unknown and cannot be recognized.

Example

Remarks

If RecognizeFirstPageOnly is true, the type of the form will be recognized based only on the first page of the form. If it is false the recognition will be done using all form image pages.

The fileName should have all form pages if RecognizeFirstPageOnly is set to false.

If all Master Forms have a different first page, then recognizing the form according to its first page will be faster.

The recognition of the form will stop comparing the form with other Master Forms either when the confidence of the recognition result is greater or equal to MinimumConfidenceRecognized or when the the Master Forms have all been compared.

The result of the recognition will be the result of the Master Form with maximum confidence. If the confidence is less than MinimumConfidenceKnownForm it will return null, i.e. the form type is unknown and cannot be recognized.

This method is useful when you have unknown forms and you want to recognize the types of these forms to archive, classify, and process.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Forms requires a Forms Module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features