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



pageIndex
The zero-based index of the page to export.
pageIndex
The zero-based index of the page to export.
Export the page at the specified index to a RasterImage object.

Syntax

Visual Basic (Declaration) 
Overloads Overridable Function ExportPage( _
   ByVal pageIndex As Integer _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As IOcrPageCollection
Dim pageIndex As Integer
Dim value As RasterImage
 
value = instance.ExportPage(pageIndex)
C# 
virtual RasterImage ExportPage( 
   int pageIndex
)
C++/CLI 
virtual RasterImage ExportPage( 
   int pageIndex
) 

Parameters

pageIndex
The zero-based index of the page to export.

Return Value

A RasterImage object containing a copy of the image data of the specified page.

Example

This example will add a page to an OCR document before exporting it back and saving it to disk

Visual BasicCopy Code
Public Sub ExportPageToRasterImageExample()
   ' 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 tifFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Ocr1.tif"
   Dim exportedFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "OcrExported.jpg"

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

         ' Add the image to the document
         ocrDocument.Pages.AddPage(tifFileName, Nothing)

         ' Export it back as a RasterImage
         Dim image As RasterImage = ocrDocument.Pages.ExportPage(0)

         ' Save this image to disk
         codecs.Save(image, exportedFileName, RasterImageFormat.Jpeg, 0)

         ' We need to dispose the image ourselves
         image.Dispose()
      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 ExportPageToRasterImageExample() 

   // 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 tifFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Ocr1.tif"; 
   string exportedFileName = LeadtoolsExamples.Common.ImagesPath.Path + "OcrExported.jpg"; 
 
   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()) 
      { 
 
         // Add the image to the document 
         ocrDocument.Pages.AddPage(tifFileName, null); 
 
         // Export it back as a RasterImage 
         RasterImage image = ocrDocument.Pages.ExportPage(0); 
 
         // Save this image to disk 
         codecs.Save(image, exportedFileName, RasterImageFormat.Jpeg, 0); 
 
         // We need to dispose the image ourselves 
         image.Dispose(); 
      } 
 
      // 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 image data to the created RasterImage object image. Therefore, after this method returns, there is no relationship between the returned value and the IOcrPage inside the OCR document. The returned RasterImage object will need to be disposed.

To export more than one page to a multi-page RasterImage object, use ExportPages(int firstPageIndex, int lastPageIndex).

This method is identical to calling IOcrPage.GetRasterImage on the page whose index is at pageIndex.

Requirements

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

See Also

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