InsertMasterFormPage Method

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#
Visual Basic
Objective-C
Java
C++

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

'Declaration
 
Public Sub InsertMasterFormPage( _
   ByVal masterFormPageNumber As Integer, _
   ByVal attributes As FormRecognitionAttributes, _
   ByVal page As RasterImage, _
   ByVal pageOptions As PageRecognitionOptions, _
   ByVal callback As PageProgressCallback _
)

'Usage
 
Dim instance As FormRecognitionEngine
Dim masterFormPageNumber As Integer
Dim attributes As FormRecognitionAttributes
Dim page As RasterImage
Dim pageOptions As PageRecognitionOptions
Dim callback As PageProgressCallback
 
instance.InsertMasterFormPage(masterFormPageNumber, attributes, page, pageOptions, callback)

public:
void InsertMasterFormPage( 
   int masterFormPageNumber,
   FormRecognitionAttributes^ attributes,
   RasterImage^ page,
   PageRecognitionOptions^ pageOptions,
   PageProgressCallback^ 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

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

This example adds a page to the master form

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

Copy Code

Imports Leadtools
Imports Leadtools.Barcode
Imports Leadtools.Codecs
Imports Leadtools.Forms
Imports Leadtools.Forms.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 Master Form recognition attributes object at the specified index.
Public Sub InsertMasterPage(recognitionEngine As FormRecognitionEngine, image As RasterImage, index As Integer, attributes As FormRecognitionAttributes)
   recognitionEngine.OpenMasterForm(attributes)
   recognitionEngine.InsertMasterFormPage(index, attributes, image, Nothing, Nothing)
   recognitionEngine.CloseMasterForm(attributes)
End Sub

using Leadtools;
using Leadtools.Barcode;
using Leadtools.Codecs;
using Leadtools.Forms;
using Leadtools.Forms.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);
}

Requirements

Target Platforms

Reference

FormRecognitionEngine Class
FormRecognitionEngine Members