AddPages(string,int,int,OcrProgressCallback) Method

Summary

Adds one or more pages from a multipage image file on disk.

Syntax

Objective-C

C++

public void AddPages( 
   string fileName, 
   int imageFirstPageNumber, 
   int imageLastPageNumber, 
   OcrProgressCallback callback 
)

Overloads Sub AddPages( _ 
   ByVal fileName As String, _ 
   ByVal imageFirstPageNumber As Integer, _ 
   ByVal imageLastPageNumber As Integer, _ 
   ByVal callback As OcrProgressCallback _ 
)

- (BOOL)addPagesWithFile:(NSString *)fileName  
                 inRange:(NSRange)range  
                   error:(NSError **)error

void AddPages(  
   String^ fileName, 
   int imageFirstPageNumber, 
   int imageLastPageNumber, 
   OcrProgressCallback^ callback 
)

Parameters

fileName
The name of the file containing the multipage image file.

imageFirstPageNumber
1-based index of the first page in fileName to add.

imageLastPageNumber
1-based index of the last page in fileName to add. A value of -1 means add up to and including the last page in fileName.

callback
Optional callback to show operation progress.

Remarks

A short-cut to add all the pages of a disk file to the OCR document is AddPages(fileName, 1, -1, callback).

To add the first page from a multipage disk file, you can also use AddPage(string fileName, OcrProgressCallback callback).

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

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 IOcrPageCollection.

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 20.0.2020.4.2