InsertFormPage Method

Summary

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

Syntax

C++

Java

public void InsertFormPage( 
   int formPageNumber, 
   FormRecognitionAttributes attributes, 
   RasterImage page, 
   PageRecognitionOptions pageOptions, 
   PageProgressCallback callback 
)

  
Public Sub InsertFormPage( _ 
   ByVal formPageNumber As Integer, _ 
   ByVal attributes As FormRecognitionAttributes, _ 
   ByVal page As RasterImage, _ 
   ByVal pageOptions As PageRecognitionOptions, _ 
   ByVal callback As PageProgressCallback _ 
)

public void insertFormPage( 
   int formPageNumber, 
   FormRecognitionAttributes attributes, 
   RasterImage page, 
   PageRecognitionOptions pageOptions, 
   PageProgressCallback callback 
);

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

Parameters

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

attributes
The Form attributes object.

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

pageOptions
Specifies the options for the page.

callback
Optional callback to show operation progress.

Remarks

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

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

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

Example

For a complete example of using form recognition and processing, refer to the FormRecognitionEngine example.

This example adds a page to the form

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 form attributes object for recognition at the specified index. 
public void InsertFormPage(FormRecognitionEngine recognitionEngine, 
                           RasterImage image, 
                           int index, 
                           FormRecognitionAttributes attributes) 
{ 
   recognitionEngine.OpenForm(attributes); 
   recognitionEngine.InsertFormPage(index, attributes, image, null, null); 
   recognitionEngine.CloseForm(attributes); 
}

Imports Leadtools 
Imports Leadtools.Barcode 
Imports Leadtools.Codecs 
Imports Leadtools.Forms.Common 
Imports Leadtools.Ocr 
Imports Leadtools.Forms.Processing 
Imports Leadtools.Forms.Recognition 
Imports Leadtools.Forms.Recognition.Barcode 
Imports Leadtools.Forms.Recognition.Ocr 
 
''' This method inserts a page to a form attributes object for recognition at the specified index. 
Public Sub InsertFormPage(recognitionEngine As FormRecognitionEngine, image As RasterImage, index As Integer, attributes As FormRecognitionAttributes) 
   recognitionEngine.OpenForm(attributes) 
   recognitionEngine.InsertFormPage(index, attributes, image, Nothing, Nothing) 
   recognitionEngine.CloseForm(attributes) 
End Sub

Requirements

Target Platforms

Reference

FormRecognitionEngine Class

FormRecognitionEngine Members

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.Forms.Recognition Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.Recognition Namespace

Assemblies