AddPage(string,OcrProgressCallback) Method

Summary

Adds a page from a disk file.

Syntax

Objective-C

C++

public IOcrPage AddPage( 
   string fileName, 
   OcrProgressCallback callback 
)

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

- (nullable LTOcrPage *)addPageWithFile:(NSString *)fileName  
                                  error:(NSError **)error

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

The IOcrPage object that define the newly added page.

Remarks

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 multipage 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 RasterCodecs object to the IOcrEngine.Startup, then this method will use the same RasterCodecs object to load the raster image file. If you did not pass a 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 value of the "Recognition.ShareOriginalImage" (only supported by the LEADTOOLS OCR Module - LEAD 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.

This member only works with memory-based documents and will throw an exception otherwise. For more information, refer to IOcrDocumentManager.CreateDocument and Programming with the LEADTOOLS .NET OCR.

Example

For an example, refer to IOcrEngine.

Requirements

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

Download our FREE evaluation

Help Version 21.0.2021.7.2