InsertFormPage Method

C#
Visual Basic
Objective-C
Java
C++

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

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

'Usage
 
Dim instance As FormRecognitionEngine
Dim formPageNumber As Integer
Dim attributes As FormRecognitionAttributes
Dim page As RasterImage
Dim pageOptions As PageRecognitionOptions
Dim callback As PageProgressCallback
 
instance.InsertFormPage(formPageNumber, attributes, page, pageOptions, 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.

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.

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

This example adds a page to the 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 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

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 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);
}

Target Platforms

Reference

FormRecognitionEngine Class
FormRecognitionEngine Members