AddMasterForm(FormRecognitionAttributes,FormPages,Uri) Method

Summary

Adds a new Master Form to this category in both the local disk and MasterForms.

Syntax

C++

Java

public IMasterForm AddMasterForm( 
   FormRecognitionAttributes attributes, 
   FormPages fields, 
   Uri url 
)

  
Public Function AddMasterForm( _ 
   ByVal attributes As FormRecognitionAttributes, _ 
   ByVal fields As FormPages, _ 
   ByVal url As Uri _ 
) As IMasterForm

public IMasterForm addMasterForm( 
   FormRecognitionAttributes,  
   FormPages,  
   java.net.URI 
);

public: 
   IMasterForm^ AddMasterForm(  
   FormRecognitionAttributes^ attributes, 
   FormPages^ fields, 
   Uri^ url 
)

Parameters

attributes
Master Form recognition attributes.

fields
Master Form processing fields.

url
A System.Uri containing the name of the Master Form image data.

Return Value

Returns the created IMasterForm object.

Remarks

The source code for this interface implementation class is available at <Install Directory>\Examples\DotNet\CS\AutoMasterFormsRepository.

The attributes must be provided, if it is null the method will throw an exception.

The added Master Form will have the Leadtools.Forms.Recognition.FormRecognitionProperties.Name of the attributes.

The Master Form files will be stored in Path.

The Master Form attributes file will have the name of the Master Form DiskMasterForm.Name with ".bin" extension. The Master Form fields file will have the name of the Master Form DiskMasterForm.Name with ".xml" extension. The Master Form image url file will have the name of the Master Form DiskMasterForm.Name with ".tif" extension.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms.Common; 
using Leadtools.Forms.Auto; 
using Leadtools.Ocr; 
using Leadtools.Forms.Recognition; 
using Leadtools.Forms.Processing; 
using Leadtools.Barcode; 
 
 
public void MasterFormGeneratioAndUpdateUri() 
{ 
   string root = Path.Combine(LEAD_VARS.ImagesDir, @"Forms\FormsDemo\OCR_Test"); 
   RasterCodecs codecs = new RasterCodecs(); 
   //create repository 
   DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root); 
 
   using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD)) 
   { 
      ocrEngine.Startup(null, null, null, LEAD_VARS.OcrLEADRuntimeDir); 
      BarcodeEngine barcodeEngine = new BarcodeEngine(); 
 
      //create AutoForm Engine 
      AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine, AutoFormsRecognitionManager.Ocr | AutoFormsRecognitionManager.Default); 
 
      repository.Refresh(); 
 
      UpdateMastersUri(repository.RootCategory, autoEngine); 
   } 
} 
 
public void UpdateMastersUri(IMasterFormsCategory category, AutoFormsEngine autoEngine) 
{ 
   foreach (IMasterForm master in category.MasterForms) 
   { 
      RasterImage form = master.ReadForm(); 
      FormRecognitionAttributes attributes = autoEngine.GenerateMasterFormAttributes(form, "New" + master.Name, Guid.Empty, null, null); 
 
      DiskMasterForm diskMaster = master as DiskMasterForm; 
      Uri url = new Uri(diskMaster.Path + ".tif"); 
      category.AddMasterForm(attributes, master.ReadFields(), url); 
   } 
 
   foreach (IMasterFormsCategory childCategory in category.ChildCategories) 
   { 
      UpdateMastersUri(childCategory, autoEngine); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS21\Resources\Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS21\Bin\Common\OcrLEADRuntime"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Forms.Common 
Imports Leadtools.Forms.Auto 
Imports Leadtools.Ocr 
Imports Leadtools.Forms.Recognition 
Imports Leadtools.Forms.Processing 
Imports Leadtools.Barcode 
 
Public Sub MasterFormGeneratioAndUpdateUri() 
 
   Dim root As String = Path.Combine(LEAD_VARS.ImagesDir, "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.LEAD) 
      ocrEngine.Startup(Nothing, Nothing, Nothing, LEAD_VARS.OcrLEADRuntimeDir) 
      Dim engineBarcode As BarcodeEngine = New BarcodeEngine() 
 
      'create AutoForm Engine 
      Dim autoEngine As AutoFormsEngine = New AutoFormsEngine(repository, ocrEngine, engineBarcode, AutoFormsRecognitionManager.Ocr Or AutoFormsRecognitionManager.Default) 
 
      repository.Refresh() 
 
      UpdateMastersUri(repository.RootCategory, autoEngine) 
   End Using 
End Sub 
 
Private Sub UpdateMastersUri(ByVal category As IMasterFormsCategory, ByVal autoEngine As AutoFormsEngine) 
   For Each master As IMasterForm In category.MasterForms 
      Dim form As RasterImage = master.ReadForm() 
      Dim attributes As FormRecognitionAttributes = autoEngine.GenerateMasterFormAttributes(form, "New" & master.Name, Guid.Empty, Nothing, Nothing) 
 
      Dim diskMaster As DiskMasterForm = TryCast(master, DiskMasterForm) 
      Dim url As Uri = New Uri(diskMaster.Path & ".tif") 
      category.AddMasterForm(attributes, master.ReadFields(), url) 
   Next master 
 
   For Each childCategory As IMasterFormsCategory In category.ChildCategories 
      UpdateMastersUri(childCategory, autoEngine) 
   Next childCategory 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\LEADTOOLS21\Resources\Images" 
   Public Const OcrLEADRuntimeDir As String = "C:\LEADTOOLS21\Bin\Common\OcrLEADRuntime" 
End Class

Requirements

Target Platforms

Reference

DiskMasterFormsCategory Class

DiskMasterFormsCategory Members

Overload List

Download our FREE evaluation

Help Version 21.0.2021.6.30

Leadtools.Forms.Auto Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.Auto Namespace

Assemblies