RecognizePage(Stream,int,AutoFormsEnginePageRecognitionOptions) Method

Recognize the type of the unknown page in a stream with options.

public AutoFormsRecognizePageResult RecognizePage( 
   Stream stream, 
   int pageNumber, 
   AutoFormsEnginePageRecognitionOptions options 
) 

Public Function RecognizePage( 
   ByVal stream As System.IO.Stream, 
   ByVal pageNumber As Integer, 
   ByVal options As AutoFormsEnginePageRecognitionOptions 
) As AutoFormsRecognizePageResult 

public:  
   AutoFormsRecognizePageResult^ RecognizePage( 
      System::IO::Stream^ stream, 
      int pageNumber, 
      AutoFormsEnginePageRecognitionOptions^ options 
   ) 

Parameters

Return Value

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

This method compares the unknown page with all Master Forms pages in the repository and returns the Master Form and the number of the page in that Master Form with maximum confidence.

The recognition of the page 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 Master Forms have all been compared.

The result of the recognition will have the result of the Master Form Page with maximum confidence. If the confidence is less than MinimumConfidenceKnownForm then null is returned, i.e. the page type is unknown and cannot be recognized.

This method is useful when you have an unknown page and you want to recognize the Master Form to which the page belongs after which you may process the form and extract the data.

For an example, refer to AutoFormsEngine.ProcessPage(Stream stream, int pageNumber, AutoFormsRecognizePageResult pageResult).

Target Platforms

Reference

AutoFormsEngine Class

AutoFormsEngine Members

Leadtools.Forms.Auto Namespace