Overloads Overridable Function AddPage( _
   ByVal image As RasterImage, _
   ByVal callback As OcrProgressCallback _
) As IOcrPage

Visual Basic (Usage)	Copy Code
Dim instance As IOcrPageCollection Dim image As RasterImage Dim callback As OcrProgressCallback Dim value As IOcrPage   value = instance.AddPage(image, callback)

virtual IOcrPage AddPage( 
   RasterImage image,
   OcrProgressCallback callback
)

virtual IOcrPage^ AddPage( 
   RasterImage image,
   OcrProgressCallback^ callback
) 

Parameters

image

The RasterImage object containing the page to add.

callback

Optional callback to show operation progress.

Return Value

This example will load a RasterImage object, perform image cleanup on it using LEADTOOLS then add it to an OCR document

Visual Basic

Copy Code

Public Sub AddPageOcrExample()    ' Unlock the support needed for LEADTOOLS Plus OCR engine    RasterSupport.Unlock(RasterSupportType.Document, "Replace with your own key here")    RasterSupport.Unlock(RasterSupportType.OcrPlus, "Replace with your own key here")    RasterSupport.Unlock(RasterSupportType.OcrPlusPdfLeadOutput, "Replace with your own key here")    ' For this example, we will use the Clean.tif image. This image is skewed so we will do that using the    ' LEADTOOLS Deskew command before we add it to the document    Dim tifFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Clean.tif"    Dim pdfFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Clean.pdf"    ' Load the TIF file    RasterCodecs.Startup()    Dim codecs As New RasterCodecs()    Dim image As RasterImage = codecs.Load(tifFileName)    ' Check if the image needs to be deskewed    Dim deskewCommand As New DeskewCheckCommand()    deskewCommand.FillColor = RasterColor.FromGdiPlusColor(Color.White)    deskewCommand.Flags = DeskewCheckCommandFlags.ReturnAngleOnly    deskewCommand.Run(image)    If (deskewCommand.Angle <> 0) Then       ' Deskew it       deskewCommand.Flags = DeskewCheckCommandFlags.UseLineDetectionToDeskewCheck       deskewCommand.Run(image)    End If    ' Create an instance of the engine    Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False)       ' Start the engine using default parameters       ' Since we have a RasterCodecs object, re-use it in the OCR engine. Although       ' this demo will not use it, it is always a good practice       ocrEngine.Startup(codecs, Nothing, Nothing, Nothing)       ' Create an OCR document       Using ocrDocument As IOcrDocument = ocrEngine.DocumentManager.CreateDocument()          ' Add the image          ocrDocument.Pages.AddPage(image, Nothing)          ' We do not need the image anymore          image.Dispose()          ' Recognize          ocrDocument.Pages.Recognize(Nothing)          ' Save          ocrDocument.Save(pdfFileName, DocumentFormat.Pdf, Nothing)       End Using       ' Shutdown the engine       ' Note: calling Dispose will also automatically shutdown the engine if it has been started       ocrEngine.Shutdown()    End Using    codecs.Dispose()    RasterCodecs.Shutdown() End Sub

C#

Copy Code

public void AddPageOcrExample()  {     // Unlock the support needed for LEADTOOLS Plus OCR engine     RasterSupport.Unlock(RasterSupportType.Document, "Replace with your own key here");     RasterSupport.Unlock(RasterSupportType.OcrPlus, "Replace with your own key here");     RasterSupport.Unlock(RasterSupportType.OcrPlusPdfLeadOutput, "Replace with your own key here");     // For this example, we will use the Clean.tif image. This image is skewed so we will do that using the     // LEADTOOLS Deskew command before we add it to the document     string tifFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Clean.tif";     string pdfFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Clean.pdf";       // Load the TIF file     RasterCodecs.Startup();     RasterCodecs codecs = new RasterCodecs();       RasterImage image = codecs.Load(tifFileName);       // Check if the image needs to be deskewed     DeskewCheckCommand deskewCommand = new DeskewCheckCommand();     deskewCommand.FillColor = RasterColor.FromGdiPlusColor(Color.White);     deskewCommand.Flags = DeskewCheckCommandFlags.ReturnAngleOnly;     deskewCommand.Run(image);       if(deskewCommand.Angle != 0)     {        // Deskew it        deskewCommand.Flags = DeskewCheckCommandFlags.UseLineDetectionToDeskewCheck;        deskewCommand.Run(image);     }       // Create an instance of the engine     using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false))     {        // Start the engine using default parameters        // Since we have a RasterCodecs object, re-use it in the OCR engine. Although        // this demo will not use it, it is always a good practice        ocrEngine.Startup(codecs, null, null, null);          // Create an OCR document        using(IOcrDocument ocrDocument = ocrEngine.DocumentManager.CreateDocument())        {           // Add the image           ocrDocument.Pages.AddPage(image, null);             // We do not need the image anymore           image.Dispose();             // Recognize           ocrDocument.Pages.Recognize(null);             // Save           ocrDocument.Save(pdfFileName, DocumentFormat.Pdf, null);        }          // Shutdown the engine        // Note: calling Dispose will also automatically shutdown the engine if it has been started        ocrEngine.Shutdown();     }       codecs.Dispose();     RasterCodecs.Shutdown();  }

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.

If image contains more than one page, then the current page as defined in RasterImage.Page is the one added to the OCR document.

To add all or specific range of the pages of a multi-page RasterImage object to the OCR document, either iterate through the pages by changing to the value of RasterImage.Page to go from 1 to RasterImage.PageCount or use the AddPages(RasterImage image, 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.

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.

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

Reference