LEADTOOLS OCR (Leadtools.Forms.Ocr assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
AddPage(Stream,OcrProgressCallback) Method
See Also 
Leadtools.Forms.Ocr Namespace > IOcrPageCollection Interface > AddPage Method : AddPage(Stream,OcrProgressCallback) Method



stream
A .NET stream containing the image.
callback
Optional callback to show operation progress.

The AddPage(Stream,OcrProgressCallback) Method is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

stream
A .NET stream containing the image.
callback
Optional callback to show operation progress.
Adds a page from a disk file.

Syntax

Visual Basic (Declaration) 
Overloads Function AddPage( _
   ByVal stream As Stream, _
   ByVal callback As OcrProgressCallback _
) As IOcrPage
Visual Basic (Usage)Copy Code
Dim instance As IOcrPageCollection
Dim stream As Stream
Dim callback As OcrProgressCallback
Dim value As IOcrPage
 
value = instance.AddPage(stream, callback)
C# 
IOcrPage AddPage( 
   Stream stream,
   OcrProgressCallback callback
)
C++/CLI 
IOcrPage^ AddPage( 
   Stream^ stream,
   OcrProgressCallback^ callback
) 

Parameters

stream
A .NET stream containing the image.
callback
Optional callback to show operation progress.

Return Value

The IOcrPage object that define the newly added page.

Example

This example will add a raster image stored in a memory stream to the OCR engine.

Remarks

This method will load the first page from a raster image stored inside a .NET stream and adds it to the OCR document.

To add all or specific range of the pages of a multi-page image file stored in a .NET stream to the OCR document, use the AddPages(Stream stream, 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 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 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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

AddPage(Stream,OcrProgressCallback) requires an OCR module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features