InsertPage(Int32,String,OcrProgressCallback) Method

C#
Visual Basic
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

IOcrPage InsertPage( 
   int pageIndex,
   string fileName,
   OcrProgressCallback callback
)

'Declaration
 
Overloads Function InsertPage( _
   ByVal pageIndex As Integer, _
   ByVal fileName As String, _
   ByVal callback As OcrProgressCallback _
) As IOcrPage

'Usage
 
Dim instance As IOcrPageCollection
Dim pageIndex As Integer
Dim fileName As String
Dim callback As OcrProgressCallback
Dim value As IOcrPage
 
value = instance.InsertPage(pageIndex, fileName, callback)

IOcrPage InsertPage( 
   int pageIndex,
   string fileName,
   OcrProgressCallback callback
)

function Leadtools.Forms.Ocr.IOcrPageCollection.InsertPage(Int32,String,OcrProgressCallback)( 
   pageIndex ,
   fileName ,
   callback 
)

IOcrPage^ InsertPage( 
   int pageIndex,
   String^ fileName,
   OcrProgressCallback^ callback
)

Parameters

pageIndex: The zero-based index at which fileName should be inserted.
fileName: The name of the file containing the image.
callback: Optional callback to show operation progress.

Return Value

The IOcrPage object that define the newly inserted page.

This method will load the first page from a raster image file on disk and inserts it to the OCR document at the specified location.

To insert all or specific range of the pages of a multi-page image file to the OCR document, use the InsertPages(int pageIndex, string fileName, int imageFirstPageNumber, int imageLastPageNumber, OcrProgressCallback callback) method.

If you passed a Leadtools.Codecs.RasterCodecs object to the IOcrEngine.Startup, then this method will use the same Leadtools.Codecs.RasterCodecs object to load the raster image file. If you did not pass a Leadtools.Codecs.RasterCodecs object, the engine will create an instance the first time one of the add or export page methods is called.

The image file in fileName can be any of the file formats supported by LEADTOOLS. For more information, refer to Summary of All Supported Image File Formats.

You can use the OcrProgressCallback to show the operation progress or to abort it. For more information and an example, refer to OcrProgressCallback.

The LEADTOOLS OCR engine supports pages of dots per inch (DPI) values of 150 and greater. If you try to add a page with a DPI of less than 150 then the engine might be able to recognize any data from this page.

Note, the LEADTOOLS Plus OCR engine does not support image size greater than A3 paper size (11.7 by 16.5 inches at 300 dpi). Attempting to add an image that has a size greater than A3 will result in an error. For document of size greater than the maximum allowed, you must first resize the image before adding it to the LEADTOOLS Plus OCR engine. The Professional and Advantage engines do not have a restriction on the image size.

Note: The value of the "Recognition.ShareOriginalImage" (only supported by the Advantage OCR engine) setting is not used when calling this method. The engine loads the image(s) and sets them in the pages internally. The original image reference can be obtained from the page using IOcrPage.GetRasterImage(OcrPageType.Original). Sharing the original image minimizes the memory used during OCR operations.

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

Copy Code

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.Forms.Ocr
Imports Leadtools.Forms
Imports Leadtools.Forms.DocumentWriters
Imports Leadtools.WinForms
Imports Leadtools.ImageProcessing.Core
Imports Leadtools.Drawing

Public Sub InsertPageFromFileExample()
   Dim imagesPath As String = LEAD_VARS.ImagesDir
   Dim pdfFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.pdf")
   ' Load the Ocr1.tif, Ocr2.tif, Ocr3.tif and Ocr4.tif to a single RasterImage object
   Dim codecs As New RasterCodecs()

   ' Create an instance of the engine
   Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Advantage, False)
      ' Since we have a RasterCodecs object, re-use it in the OCR engine. Although
      ' this demo will not use it, it is always a good practice
      ocrEngine.Startup(codecs, Nothing, Nothing, LEAD_VARS.OcrAdvantageRuntimeDir)

      ' Create an OCR document
      Using ocrDocument As IOcrDocument = ocrEngine.DocumentManager.CreateDocument()
         ' Loop through the images, insert them in the reverse order
         For i As Integer = 0 To 3
            Dim pageFileName As String = Path.Combine(imagesPath, String.Format("Ocr{0}.tif", i + 1))
            ocrDocument.Pages.InsertPage(0, pageFileName, Nothing)
         Next

         ' Recognize
         ocrDocument.Pages.Recognize(Nothing)

         ' Save
         ocrDocument.Save(pdfFileName, DocumentFormat.Pdf, Nothing)
      End Using

      ' Shutdown the engine
      ' Note: calling Dispose will also automatically shutdown the engine if it has been started
      ocrEngine.Shutdown()
   End Using

   codecs.Dispose()
End Sub

Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
Public Const OcrAdvantageRuntimeDir As String = "C:\LEADTOOLS 18\Bin\Common\OcrAdvantageRuntime"
End Class

using Leadtools;
using Leadtools.Codecs;
using Leadtools.Forms.Ocr;
using Leadtools.Forms.DocumentWriters;
using Leadtools.Forms;
using Leadtools.ImageProcessing.Core;

public void InsertPageFromFileExample()
{
   string pdfFileName = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.pdf");
   // Load the Ocr1.tif, Ocr2.tif, Ocr3.tif and Ocr4.tif to a single RasterImage object
   RasterCodecs codecs = new RasterCodecs();

   // Create an instance of the engine
   using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Advantage, false))
   {
      // Since we have a RasterCodecs object, re-use it in the OCR engine. Although
      // this demo will not use it, it is always a good practice
      ocrEngine.Startup(codecs, null, null, LEAD_VARS.OcrAdvantageRuntimeDir);

      // Create an OCR document
      using (IOcrDocument ocrDocument = ocrEngine.DocumentManager.CreateDocument())
      {
         // Loop through the images, insert them in the reverse order
         for (int i = 0; i < 4; i++)
         {
            string pageFileName = Path.Combine(LEAD_VARS.ImagesDir, string.Format("Ocr{0}.tif", i + 1));
            ocrDocument.Pages.InsertPage(0, pageFileName, null);
         }

         // Recognize
         ocrDocument.Pages.Recognize(0, 1, null);

         // Save
         ocrDocument.Save(pdfFileName, DocumentFormat.Pdf, null);
      }

      // Shutdown the engine
      // Note: calling Dispose will also automatically shutdown the engine if it has been started
      ocrEngine.Shutdown();
   }

   codecs.Dispose();
}

static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
public const string OcrAdvantageRuntimeDir = @"C:\LEADTOOLS 18\Bin\Common\OcrAdvantageRuntime";
}

Target Platforms

Reference

IOcrPageCollection Interface
IOcrPageCollection Members
Overload List
OcrEngineManager Class
OcrEngineType Enumeration
IOcrPage Interface
Programming with the LEADTOOLS .NET OCR