InsertMasterFormPage Method

Summary

Appends a new page to the specified Master Form attributes object. The Master Form attributes object should be opened before the addition using OpenMasterForm.

Syntax

C++/CLI

Java

Python

public void InsertMasterFormPage( 
   int masterFormPageNumber, 
   FormRecognitionAttributes attributes, 
   RasterImage page, 
   PageRecognitionOptions pageOptions, 
   PageProgressCallback callback 
)

public void insertMasterFormPage( 
   int masterFormPageNumber, 
   FormRecognitionAttributes attributes, 
   RasterImage page, 
   PageRecognitionOptions pageOptions, 
   PageProgressCallback callback 
);

public: 
void InsertMasterFormPage(  
   int masterFormPageNumber, 
   FormRecognitionAttributes^ attributes, 
   RasterImage^ page, 
   PageRecognitionOptions^ pageOptions, 
   PageProgressCallback^ callback 
)

def InsertMasterFormPage(self,masterFormPageNumber,attributes,page,pageOptions,callback):

Parameters

masterFormPageNumber
The One-Based index at which page should be inserted.

attributes
The Master Form attributes object.

page
The page image that is going to be added to Master Form attributes object.

pageOptions
Specifies the page options.

callback
Optional callback to show operation progress.

Remarks

The attributes object should be a Master Form attributes object, this method does not work for Forms attributes object. To add a page to a Form attributes object use AddFormPage(FormRecognitionAttributes,RasterImage,PageRecognitionOptions).

If masterFormPageNumber is equal to -1 the page will be appended to the form pages.

If masterFormPageNumber is greater than the number of form pages an exception is thrown.

Example

This example adds a page to the master form

Java

using Leadtools; 
using Leadtools.Barcode; 
using Leadtools.Codecs; 
using Leadtools.Forms.Common; 
using Leadtools.Ocr; 
using Leadtools.Forms.Processing; 
using Leadtools.Forms.Recognition; 
using Leadtools.Forms.Recognition.Barcode; 
using Leadtools.Forms.Recognition.Ocr; 
 
/// This method inserts a page to a Master Form recognition attributes object at the specified index. 
public void InsertMasterPage(FormRecognitionEngine recognitionEngine, 
                             RasterImage image, 
                             int index, 
                             FormRecognitionAttributes attributes) 
{ 
   recognitionEngine.OpenMasterForm(attributes); 
   recognitionEngine.InsertMasterFormPage(index, attributes, image, null, null); 
   recognitionEngine.CloseMasterForm(attributes); 
}

 
import java.io.File; 
import java.io.IOException; 
import java.util.UUID; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.forms.recognition.*; 
 
 
public void insertMasterPage() { 
   FormRecognitionEngine recognitionEngine = new FormRecognitionEngine(); 
   RasterImage image = new RasterCodecs().load("C:\\LEADTOOLS23\\Resources\\Images\\ocr1.tif"); 
   int index = 0; 
   FormRecognitionOptions formOptions = new FormRecognitionOptions(); 
   FormRecognitionAttributes attributes = recognitionEngine.createMasterForm("MasterForm", UUID.randomUUID(), 
         formOptions); 
 
   // Only reopen your master form if it's it already open 
   // recognitionEngine.openMasterForm(attributes); 
   recognitionEngine.insertMasterFormPage(index, attributes, image, null, null); 
   assert (attributes.getFRForm().getPages().size() == 1); 
   recognitionEngine.closeMasterForm(attributes); 
}

Requirements

Target Platforms

Reference

FormRecognitionEngine Class

FormRecognitionEngine Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Forms.Recognition Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.Recognition Namespace

Assemblies