Overloads Public Function CompareForm( _
   ByVal masterAttributes As FormRecognitionAttributes, _
   ByVal formAttributes As FormRecognitionAttributes, _
   ByVal formCallback As FormProgressCallback, _
   ByVal pageCallback As PageProgressCallback _
) As FormRecognitionResult

Visual Basic (Usage)	Copy Code
Dim instance As FormRecognitionEngine Dim masterAttributes As FormRecognitionAttributes Dim formAttributes As FormRecognitionAttributes Dim formCallback As FormProgressCallback Dim pageCallback As PageProgressCallback Dim value As FormRecognitionResult   value = instance.CompareForm(masterAttributes, formAttributes, formCallback, pageCallback)

public FormRecognitionResult CompareForm( 
   FormRecognitionAttributes masterAttributes,
   FormRecognitionAttributes formAttributes,
   FormProgressCallback formCallback,
   PageProgressCallback pageCallback
)

public:
FormRecognitionResult^ CompareForm( 
   FormRecognitionAttributes^ masterAttributes,
   FormRecognitionAttributes^ formAttributes,
   FormProgressCallback^ formCallback,
   PageProgressCallback^ pageCallback
) 

Parameters

masterAttributes

The Master Form attribute object.

formAttributes

The Form attribute object.

formCallback

Status about the progress of the comparison at the form level (i.e. page by page). Set it to null to ignore the progress.

pageCallback

Provides status on the progress of the comparison at the page level. Set it to null to ignore the progress.

For a complete example of using form recognition and processing, refer to the FormRecognitionEngine example.

This example compares a Master Form with a Form.

Visual Basic	Copy Code
'''This method compares a Form to a Master Form using all pages. Private Function CompareForm(ByVal recognitionEngine As FormRecognitionEngine, ByVal master As FormRecognitionAttributes, ByVal form As FormRecognitionAttributes) As FormRecognitionResult Return recognitionEngine.CompareForm(master, form, Nothing) End Function

C#	Copy Code
///This method compares a Form to a Master Form using all pages. FormRecognitionResult CompareForm(FormRecognitionEngine recognitionEngine, FormRecognitionAttributes master, FormRecognitionAttributes form) { return recognitionEngine.CompareForm(master, form, null); }

In a case that the number of pages in unKnown of the Form, such as scanner loaded with different forms, it is preferable to use FormRecognitionEngine.ComparePage to compare it with the first page of each Master Form then use FormRecognitionEngine.GetFormProperties to get the number of pages of the Master Form then update your Form attributes with the required pages if needed for processing.

In order to recognize a Form, the Form attribute object must be compared with all of the Master Form attribute objects representing different types of form templates. The Form's type is that Master Form attribute object that generated the highest confidence value. If the highest confidence value is very low that means the Form is not one the types of the Master Forms (i.e. the type of this Form is not defined in the Master Form set)

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

Reference