AddPage(String,OcrProgressCallback) Method

IOcrPage AddPage( 
   string fileName,
   OcrProgressCallback callback
)

'Declaration
 
Overloads Function AddPage( _
   ByVal fileName As String, _
   ByVal callback As OcrProgressCallback _
) As IOcrPage

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

IOcrPage AddPage( 
   string fileName,
   OcrProgressCallback callback
)

function Leadtools.Forms.Ocr.IOcrPageCollection.AddPage(String,OcrProgressCallback)( 
   fileName ,
   callback 
)

IOcrPage^ AddPage( 
   String^ fileName,
   OcrProgressCallback^ callback
) 

Parameters

fileName

The name of the file containing the image.

callback

Optional callback to show operation progress.

Return Value

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

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

This method will add the page to the end of the collection if you already have pages in this IOcrPageCollection.

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.

Target Platforms

Reference

IOcrPageCollection Interface
IOcrPageCollection Members
Overload List
OcrEngineManager Class
OcrEngineType Enumeration
IOcrPage Interface
Programming with the LEADTOOLS .NET OCR
Summary of All Supported Image File Formats