InsertPages(int,RasterImage,int,int,OcrProgressCallback) Method

Summary

Insert one or more pages from a multipage RasterImage object at the specified location.

Syntax

Objective-C

C++

Java

public void InsertPages( 
   int pageIndex, 
   RasterImage image, 
   int imageFirstPageNumber, 
   int imageLastPageNumber, 
   OcrProgressCallback callback 
)

Overloads Sub InsertPages( _ 
   ByVal pageIndex As Integer, _ 
   ByVal image As RasterImage, _ 
   ByVal imageFirstPageNumber As Integer, _ 
   ByVal imageLastPageNumber As Integer, _ 
   ByVal callback As OcrProgressCallback _ 
)

- (BOOL)insertPagesAtIndex:(NSUInteger)pageIndex 
                     image:(LTRasterImage *)image 
                   inRange:(NSRange)range 
                     error:(NSError **)error

public void insertPages(int pageIndex, 
                        RasterImage image, 
                        int imageFirstPageNumber, 
                        int imageLastPageNumber, 
                        OcrProgressListener callback)

void InsertPages(  
   int pageIndex, 
   RasterImage^ image, 
   int imageFirstPageNumber, 
   int imageLastPageNumber, 
   OcrProgressCallback^ callback 
)

Parameters

pageIndex
The zero-based index at which the new pages from image should be inserted.

image
The RasterImage object containing the pages to insert.

imageFirstPageNumber
1-based index of the first page in image to insert.

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

callback
Optional callback to show operation progress.

Remarks

This method copies the RasterImage object image data into the newly created IOcrPage. Therefore, after this method returns, there is no relationship between image and the IOcrPage inside the OCR document. For example, if you do not need the image object after calling this method, you should dispose it after this method returns.

This method guarantees that no changes will be made to image.

A short-cut to insert all the pages of a RasterImage object to the OCR document is InsertPages(index, image, 1, -1, callback).

To insert a single page from a RasterImage object, you can use InsertPage(int pageIndex, RasterImage image, OcrProgressCallback callback).

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 will make a copy of image and store it in the page. Calling IOcrPage.GetRasterImage(OcrPageType.Original) on the page will return a null reference.

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 on how to insert a page, refer to InsertPage. For an example on how to add pages from a RasterImage, refer to AddPages.

Requirements

Target Platforms

Reference

IOcrPageCollection Interface

IOcrPageCollection Members

Overload List

OcrEngineManager Class

OcrEngineType Enumeration

IOcrPage Interface

Programming with the LEADTOOLS .NET OCR

Download our FREE evaluation

Help Version 20.0.2020.4.2