InsertPages(int,Stream,int,int,OcrProgressCallback) Method

Summary

Insert one or more pages from a multipage image file stored in a .NET stream at the specified location.

Syntax

Objective-C

C++

Java

public void InsertPages( 
   int pageIndex, 
   Stream stream, 
   int imageFirstPageNumber, 
   int imageLastPageNumber, 
   OcrProgressCallback callback 
)

Overloads Sub InsertPages( _ 
   ByVal pageIndex As Integer, _ 
   ByVal stream As Stream, _ 
   ByVal imageFirstPageNumber As Integer, _ 
   ByVal imageLastPageNumber As Integer, _ 
   ByVal callback As OcrProgressCallback _ 
)

- (BOOL)insertPagesAtIndex:(NSUInteger)pageIndex 
                    stream:(LTLeadStream *)stream 
                   inRange:(NSRange)range 
                     error:(NSError **)error

public void insertPages(int pageIndex, 
                        ILeadStream stream, 
                        int imageFirstPageNumber, 
                        int imageLastPageNumber, 
                        OcrProgressListener callback)

void InsertPages(  
   int pageIndex, 
   Stream^ stream, 
   int imageFirstPageNumber, 
   int imageLastPageNumber, 
   OcrProgressCallback^ callback 
)

Parameters

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

stream
The .NET stream containing the multipage image file.

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

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

callback
Optional callback to show operation progress.

Remarks

A short-cut to insert all the pages of an image file stored in a stream to the OCR document is InsertPages(index, stream, 1, -1, callback).

To insert a single page from a multipage image stored in a stream, you can also use AddPage(int pageIndex, Stream stream, OcrProgressCallback callback).

The image file in stream 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 on how to insert a page, refer to InsertPage. For an example on how to add pages from a .NET stream, 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

Summary of All Supported Image File Formats

Download our FREE evaluation

Help Version 20.0.2020.4.2