Leadtools.Forms.Auto	Requires Document/Medical product license \| Send comments on this topic. \| Back to Introduction - All Topics \| Help Version 16.5.9.25
AutoFormsEngine Constructor(IMasterFormsRepository,IOcrEngine,BarcodeEngine,AutoFormsRecognitionManager,Int32,Int32,Boolean)
See Also Example

Leadtools.Forms.Auto Namespace > AutoFormsEngine Class > AutoFormsEngine Constructor : AutoFormsEngine Constructor(IMasterFormsRepository,IOcrEngine,BarcodeEngine,AutoFormsRecognitionManager,Int32,Int32,Boolean)

Visual Basic (Declaration)
Visual Basic (Usage)
C#
C++/CLI

repository: Repository of the Master Forms.

ocrEngine: The IOcrEngine that is used for optical character recognition and processing.

barcodeEngine: The BarcodeEngine that is used for barcode recognition and processing.

managers: The Object Managers to be used to recognize forms and generate Master Forms attributes in GenerateMasterFormAttributes.

minimumConfidenceKnownForm: The minimum confidence value to decide that the Form type result is a known type. It ranges from 0 to 100 and usually it is less than minimumConfidenceRecognized.

minimumConfidenceRecognized: The minimum confidence value to decide that the Form type is recognized and no further comparison with Master Forms is needed. It ranges from 0 to 100 and usually it is greater than minimumConfidenceKnownForm.

recognizeFirstPageOnly: Recognize the form based on the first page only.

Initializes a new AutoFormsEngine class object.

Syntax

Visual Basic (Declaration)
Public Function New( _ ByVal repository As IMasterFormsRepository, _ ByVal ocrEngine As IOcrEngine, _ ByVal barcodeEngine As BarcodeEngine, _ ByVal managers As AutoFormsRecognitionManager, _ ByVal minimumConfidenceKnownForm As Integer, _ ByVal minimumConfidenceRecognized As Integer, _ ByVal recognizeFirstPageOnly As Boolean _ )

Visual Basic (Declaration)

Public Function New( _
   ByVal repository As IMasterFormsRepository, _
   ByVal ocrEngine As IOcrEngine, _
   ByVal barcodeEngine As BarcodeEngine, _
   ByVal managers As AutoFormsRecognitionManager, _
   ByVal minimumConfidenceKnownForm As Integer, _
   ByVal minimumConfidenceRecognized As Integer, _
   ByVal recognizeFirstPageOnly As Boolean _
)

Visual Basic (Usage) Copy Code

Visual Basic (Usage)	Copy Code
`Dim repository As IMasterFormsRepository Dim ocrEngine As IOcrEngine Dim barcodeEngine As BarcodeEngine Dim managers As AutoFormsRecognitionManager Dim minimumConfidenceKnownForm As Integer Dim minimumConfidenceRecognized As Integer Dim recognizeFirstPageOnly As Boolean Dim instance As AutoFormsEngine(repository, ocrEngine, barcodeEngine, managers, minimumConfidenceKnownForm, minimumConfidenceRecognized, recognizeFirstPageOnly)`

Dim repository As IMasterFormsRepository
Dim ocrEngine As IOcrEngine
Dim barcodeEngine As BarcodeEngine
Dim managers As AutoFormsRecognitionManager
Dim minimumConfidenceKnownForm As Integer
Dim minimumConfidenceRecognized As Integer
Dim recognizeFirstPageOnly As Boolean
 
Dim instance As AutoFormsEngine(repository, ocrEngine, barcodeEngine, managers, minimumConfidenceKnownForm, minimumConfidenceRecognized, recognizeFirstPageOnly)

C#
public AutoFormsEngine( IMasterFormsRepository repository, IOcrEngine ocrEngine, BarcodeEngine barcodeEngine, AutoFormsRecognitionManager managers, int minimumConfidenceKnownForm, int minimumConfidenceRecognized, bool recognizeFirstPageOnly )

public AutoFormsEngine( 
   IMasterFormsRepository repository,
   IOcrEngine ocrEngine,
   BarcodeEngine barcodeEngine,
   AutoFormsRecognitionManager managers,
   int minimumConfidenceKnownForm,
   int minimumConfidenceRecognized,
   bool recognizeFirstPageOnly
)

C++/CLI
public: AutoFormsEngine( IMasterFormsRepository^ repository, IOcrEngine ocrEngine, BarcodeEngine barcodeEngine, AutoFormsRecognitionManager managers, int minimumConfidenceKnownForm, int minimumConfidenceRecognized, bool recognizeFirstPageOnly )

C++/CLI

public:
AutoFormsEngine( 
   IMasterFormsRepository^ repository,
   IOcrEngine ocrEngine,
   BarcodeEngine barcodeEngine,
   AutoFormsRecognitionManager managers,
   int minimumConfidenceKnownForm,
   int minimumConfidenceRecognized,
   bool recognizeFirstPageOnly
)

Parameters

repository: Repository of the Master Forms.
ocrEngine: The IOcrEngine that is used for optical character recognition and processing.
barcodeEngine: The BarcodeEngine that is used for barcode recognition and processing.
managers: The Object Managers to be used to recognize forms and generate Master Forms attributes in GenerateMasterFormAttributes.
minimumConfidenceKnownForm: The minimum confidence value to decide that the Form type result is a known type. It ranges from 0 to 100 and usually it is less than minimumConfidenceRecognized.
minimumConfidenceRecognized: The minimum confidence value to decide that the Form type is recognized and no further comparison with Master Forms is needed. It ranges from 0 to 100 and usually it is greater than minimumConfidenceKnownForm.
recognizeFirstPageOnly: Recognize the form based on the first page only.

Example

Visual Basic Copy Code

Visual Basic	Copy Code
Public Sub AutoFormRunManual() RasterCodecs.Startup() Dim root As String = LeadtoolsExamples.Common.ImagesPath.Path + "Forms\FormsDemo\OCR_Test" Dim codecs_Renamed As RasterCodecs = New RasterCodecs() 'create repository Dim repository As DiskMasterFormsRepository = New DiskMasterFormsRepository(codecs_Renamed, root) Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False) ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing) BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d Or BarcodeMajorTypeFlags.Barcodes2dRead Or BarcodeMajorTypeFlags.BarcodesDatamatrixRead Or BarcodeMajorTypeFlags.BarcodesPdfRead Or BarcodeMajorTypeFlags.BarcodesQrRead) Dim engineBarcode As BarcodeEngine = New BarcodeEngine() 'create AutoForm Engine Dim autoEngine As AutoFormsEngine = New AutoFormsEngine(repository, ocrEngine, engineBarcode, AutoFormsRecognitionManager.Ocr Or AutoFormsRecognitionManager.Default, 30, 80, True) 'load the first page of the image Dim form As RasterImage = codecs_Renamed.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Forms\Images\FCC-107_OCR_Filled.tif", 1, CodecsLoadByteOrder.Bgr, 1, -1) 'recognize and process the form Dim result As AutoFormsRunResult = autoEngine.Run(form, Nothing, Nothing, Nothing) If result Is Nothing Then Return End If End Using RasterCodecs.Shutdown() End Sub

Public Sub AutoFormRunManual()

   RasterCodecs.Startup()

   Dim root As String = LeadtoolsExamples.Common.ImagesPath.Path + "Forms\FormsDemo\OCR_Test"



   Dim codecs_Renamed As RasterCodecs = New RasterCodecs()

   'create repository

   Dim repository As DiskMasterFormsRepository = New DiskMasterFormsRepository(codecs_Renamed, root)



   Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False)

      ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing)

      BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d Or BarcodeMajorTypeFlags.Barcodes2dRead Or BarcodeMajorTypeFlags.BarcodesDatamatrixRead Or BarcodeMajorTypeFlags.BarcodesPdfRead Or BarcodeMajorTypeFlags.BarcodesQrRead)

      Dim engineBarcode As BarcodeEngine = New BarcodeEngine()



      'create AutoForm Engine

      Dim autoEngine As AutoFormsEngine = New AutoFormsEngine(repository, ocrEngine, engineBarcode, AutoFormsRecognitionManager.Ocr Or AutoFormsRecognitionManager.Default, 30, 80, True)



      'load the first page of the image

      Dim form As RasterImage = codecs_Renamed.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Forms\Images\FCC-107_OCR_Filled.tif", 1, CodecsLoadByteOrder.Bgr, 1, -1)

      'recognize and process the form

      Dim result As AutoFormsRunResult = autoEngine.Run(form, Nothing, Nothing, Nothing)

      If result Is Nothing Then

         Return

      End If

   End Using

   RasterCodecs.Shutdown()

End Sub

C# Copy Code

C#	Copy Code
public void AutoFormRunManual() { RasterCodecs.Startup(); string root = LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\FormsDemo\OCR_Test"; RasterCodecs codecs = new RasterCodecs(); //create repository DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root); using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false)) { ocrEngine.Startup(null, null, null,null); BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d \| BarcodeMajorTypeFlags.Barcodes2dRead \| BarcodeMajorTypeFlags.BarcodesDatamatrixRead \| BarcodeMajorTypeFlags.BarcodesPdfRead \| BarcodeMajorTypeFlags.BarcodesQrRead); BarcodeEngine barcodeEngine = new BarcodeEngine(); //create AutoForm Engine AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine, AutoFormsRecognitionManager.Ocr \| AutoFormsRecognitionManager.Default, 30, 80, true); //load the first page of the image RasterImage form = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\Images\FCC-107_OCR_Filled.tif", 1, CodecsLoadByteOrder.Bgr, 1, -1); //recognize and process the form AutoFormsRunResult result = autoEngine.Run(form, null, null, null); if(result == null) return; } RasterCodecs.Shutdown(); }

public void AutoFormRunManual() 
{ 
   RasterCodecs.Startup(); 
 
   string root = LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\FormsDemo\OCR_Test"; 
   RasterCodecs codecs = new RasterCodecs(); 
   //create repository 
   DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root); 
 
   using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false)) 
   { 
      ocrEngine.Startup(null, null, null,null); 
      BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d | BarcodeMajorTypeFlags.Barcodes2dRead | BarcodeMajorTypeFlags.BarcodesDatamatrixRead | BarcodeMajorTypeFlags.BarcodesPdfRead | BarcodeMajorTypeFlags.BarcodesQrRead); 
      BarcodeEngine barcodeEngine = new BarcodeEngine(); 
 
      //create AutoForm Engine 
      AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine, AutoFormsRecognitionManager.Ocr | AutoFormsRecognitionManager.Default, 30, 80, true); 
 
      //load the first page of the image 
      RasterImage form = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\Images\FCC-107_OCR_Filled.tif", 1, CodecsLoadByteOrder.Bgr, 1, -1); 
      //recognize and process the form 
      AutoFormsRunResult result = autoEngine.Run(form, null, null, null); 
      if(result == null) 
         return; 
   } 
   RasterCodecs.Shutdown(); 
}

Remarks

It is the user's responsibility to dispose of this object when it is no longer needed by calling Dispose.

If ocrEngine is null, OcrObjectsManager will not be used for recognition and TextFormField and OmrFormField will not be processed.

If barcodeEngine is null, BarcodeObjectsManager will not be used for recognition and BarcodeFormField will not be processed.

The recognition Object Managers will be set to the managers used to generate the Master Forms in the repository.

Requirements

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

Syntax

Parameters

Example

Remarks

Requirements

See Also

Reference