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



pageIndex
The zero-based index at which image should be inserted.
image
The RasterImage object containing the page to insert.
callback
Optional callback to show operation progress.
pageIndex
The zero-based index at which image should be inserted.
image
The RasterImage object containing the page to insert.
callback
Optional callback to show operation progress.
Inserts a RasterImage object to the specified location.

Syntax

Visual Basic (Declaration) 
Overloads Overridable Function InsertPage( _
   ByVal pageIndex As Integer, _
   ByVal image As RasterImage, _
   ByVal callback As OcrProgressCallback _
) As IOcrPage
Visual Basic (Usage)Copy Code
Dim instance As IOcrPageCollection
Dim pageIndex As Integer
Dim image As RasterImage
Dim callback As OcrProgressCallback
Dim value As IOcrPage
 
value = instance.InsertPage(pageIndex, image, callback)
C# 
virtual IOcrPage InsertPage( 
   int pageIndex,
   RasterImage image,
   OcrProgressCallback callback
)
C++/CLI 
virtual IOcrPage^ InsertPage( 
   int pageIndex,
   RasterImage image,
   OcrProgressCallback^ callback
) 

Parameters

pageIndex
The zero-based index at which image should be inserted.
image
The RasterImage object containing the page to insert.
callback
Optional callback to show operation progress.

Return Value

The IOcrPage object that define the newly inserted page.

Example

This example will load then insert in reverse order a group of RasterImage objects.

Visual BasicCopy Code
Public Sub InsertPageFromRasterImageExample()
   ' 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")
   Dim imagesPath As String = LeadtoolsExamples.Common.ImagesPath.Path
   Dim pdfFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Ocr1.pdf"

   ' Load the Ocr1.tif, Ocr2.tif, Ocr3.tif and Ocr4.tif to a single RasterImage object
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()

   ' Create an instance of the engine
   Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False)
      ' 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()
         ' Loop through the images, insert them in the reverse order
         For i As Integer = 0 To 3
            Dim pageFileName As String = Path.Combine(imagesPath, String.Format("Ocr{0}.tif", i + 1))
            Using image As RasterImage = codecs.Load(pageFileName)
               ocrDocument.Pages.InsertPage(0, image, Nothing)
            End Using
         Next

         ' 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 InsertPageFromRasterImageExample() 

   // 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"); 
   string imagesPath = LeadtoolsExamples.Common.ImagesPath.Path; 
   string pdfFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Ocr1.pdf"; 
 
   // Load the Ocr1.tif, Ocr2.tif, Ocr3.tif and Ocr4.tif to a single RasterImage object 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Create an instance of the engine 
   using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false)) 
   { 
      // 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()) 
      { 
         // Loop through the images, insert them in the reverse order 
         for(int i = 0; i < 4; i++) 
         { 
            string pageFileName = Path.Combine(imagesPath, string.Format("Ocr{0}.tif", i + 1)); 
            using(RasterImage image = codecs.Load(pageFileName)) 
               ocrDocument.Pages.InsertPage(0, image, 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(); 
   } 
 
   codecs.Dispose(); 
   RasterCodecs.Shutdown(); 
}

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.

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

To insert 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 InsertPages(int pageIndex, RasterImage image, int imageFirstPageNumber, int imageLastPageNumber, OcrProgressCallback callback) method.

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

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