LEADTOOLS Forms (Leadtools.Forms.Recognition assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
InsertFormPage Method
See Also 
Leadtools.Forms.Recognition Namespace > FormRecognitionEngine Class : InsertFormPage Method



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 InsertFormPage Method is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

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.
Appends a new page to the specified Form attributes object. The Form attributes object should be opened before the addition using FormRecognitionEngine.OpenForm.

Syntax

Visual Basic (Declaration) 
Public Sub InsertFormPage( _
   ByVal formPageNumber As Integer, _
   ByVal attributes As FormRecognitionAttributes, _
   ByVal page As RasterImage, _
   ByVal pageOptions As PageRecognitionOptions, _
   ByVal callback As PageProgressCallback _
) 
Visual Basic (Usage)Copy Code
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)

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.

Example

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

This example adds a page to the form

Visual BasicCopy Code
''' This method inserts a page to a form attributes object for recognition at the specified index.
Public Sub InsertFormPage(ByVal recognitionEngine As FormRecognitionEngine, ByVal image As RasterImage, ByVal index As Integer, ByVal attributes As FormRecognitionAttributes)
    recognitionEngine.OpenForm(attributes)
    recognitionEngine.InsertFormPage(index, attributes, image, Nothing, Nothing)
    recognitionEngine.CloseForm(attributes)
End Sub
C#Copy Code
/// 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);
}

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 FormRecognitionEngine.AddMasterFormPage.

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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

Leadtools.Forms requires a Forms Module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features