AddMasterForm(FormRecognitionAttributes,FormPages,String) Method

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public virtual IMasterForm AddMasterForm( 
   FormRecognitionAttributes attributes,
   FormPages fields,
   string fileName
)

'Declaration
 
Public Overloads Overridable Function AddMasterForm( _
   ByVal attributes As FormRecognitionAttributes, _
   ByVal fields As FormPages, _
   ByVal fileName As String _
) As IMasterForm

'Usage
 
Dim instance As DiskMasterFormsCategory
Dim attributes As FormRecognitionAttributes
Dim fields As FormPages
Dim fileName As String
Dim value As IMasterForm
 
value = instance.AddMasterForm(attributes, fields, fileName)

public virtual IMasterForm AddMasterForm( 
   FormRecognitionAttributes attributes,
   FormPages fields,
   string fileName
)

 function Leadtools.Forms.Auto.DiskMasterFormsCategory.AddMasterForm(FormRecognitionAttributes,FormPages,String)( 
   attributes ,
   fields ,
   fileName 
)

public:
virtual IMasterForm^ AddMasterForm( 
   FormRecognitionAttributes^ attributes,
   FormPages^ fields,
   String^ fileName
)

Parameters

attributes: Master Form recognition attributes.
fields: Master Form processing fields.
fileName: A System.String containing the name of the Master Form image file.

Return Value

Returns the created IMasterForm object.

The source code of 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 fileName file will have the name of the Master Form DiskMasterForm.Name with ".tif" extension.

The form is stored as a 1-bit black and white tif image.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub MasterFormGeneratioAndUpdateFile()
      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.Plus, False)
         ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing)
         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()

         UpdateMastersFile(repository.RootCategory, autoEngine)
      End Using
   End Sub

   Private Sub UpdateMastersFile(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)
         category.AddMasterForm(attributes, master.ReadFields(), diskMaster.Path & ".tif")
      Next master

      For Each childCategory As IMasterFormsCategory In category.ChildCategories
         UpdateMastersFile(childCategory, autoEngine)
      Next childCategory
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void MasterFormGeneratioAndUpdateFile()
   {
      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.Plus, false))
      {
         ocrEngine.Startup(null, null, null, null);
         BarcodeEngine barcodeEngine = new BarcodeEngine();

         //create AutoForm Engine
         AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine, AutoFormsRecognitionManager.Ocr | AutoFormsRecognitionManager.Default);

         repository.Refresh();

         UpdateMastersFile(repository.RootCategory, autoEngine);
      }
   }

   public void UpdateMastersFile(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;
         category.AddMasterForm(attributes, master.ReadFields(), diskMaster.Path+".tif");
      }

      foreach(IMasterFormsCategory childCategory in category.ChildCategories)
      {
         UpdateMastersFile(childCategory, autoEngine);
      }
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DiskMasterFormsCategory Class
DiskMasterFormsCategory Members
Overload List