Leadtools.Forms.Ocr Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
AddPage(Uri,OcrProgressCallback) Method
See Also  Example
Leadtools.Forms.Ocr Namespace > IOcrPageCollection Interface > AddPage Method : AddPage(Uri,OcrProgressCallback) Method



uri
A URI containing the path to the image.
callback
Optional callback to show operation progress.
uri
A URI containing the path to the image.
callback
Optional callback to show operation progress.
Adds a page from a URI.

Syntax

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

Parameters

uri
A URI containing the path to 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 an HTTP location to an OCR document.

Visual BasicCopy Code
Public Sub AddPageFromUriExample()
   ' 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")
   ' Change this URI to the location of the image you want to load
   Dim uri As New Uri("http:'localhost/MyImages/Ocr1.tif")
   Dim pdfFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Ocr1.pdf"

   ' Create an instance of the engine
   Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False)
      ' Start the engine using default parameters
      ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing)

      ' Create an OCR document
      Using ocrDocument As IOcrDocument = ocrEngine.DocumentManager.CreateDocument()
         ' Add the image
         ocrDocument.Pages.AddPage(uri, Nothing)

         ' 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
End Sub
C#Copy Code
public void AddPageFromUriExample() 

   // 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"); 
   // Change this URI to the location of the image you want to load 
   Uri uri = new Uri(@"http://localhost/MyImages/Ocr1.tif"); 
   string pdfFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Ocr1.pdf"; 
 
   // Create an instance of the engine 
   using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false)) 
   { 
      // Start the engine using default parameters 
      ocrEngine.Startup(null, null, null, null); 
 
      // Create an OCR document 
      using(IOcrDocument ocrDocument = ocrEngine.DocumentManager.CreateDocument()) 
      { 
         // Add the image 
         ocrDocument.Pages.AddPage(uri, null); 
 
         // 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(); 
   } 
}

Remarks

This method will load the first page from a raster image stored in a URI and adds it to the OCR document.

The URI can point to a file in a remote HTTP server, UNC or FTP.

To add all or specific range of the pages of a multi-page image file stored in a URI to the OCR document, use the AddPages(Uri uri, 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 RasterCodecs object to the IOcrEngine.Startup, then this method will use the same RasterCodecs object to load the raster image file. If you did not pass a 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 uri 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 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

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