ExportPage(Int32) Method

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

RasterImage ExportPage( 
   int pageIndex
)

'Declaration
 
Overloads Function ExportPage( _
   ByVal pageIndex As Integer _
) As RasterImage

'Usage
 
Dim instance As IOcrPageCollection
Dim pageIndex As Integer
Dim value As RasterImage
 
value = instance.ExportPage(pageIndex)

RasterImage ExportPage( 
   int pageIndex
)

function Leadtools.Forms.Ocr.IOcrPageCollection.ExportPage(Int32)( 
   pageIndex 
)

RasterImage^ ExportPage( 
   int pageIndex
)

Parameters

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

Return Value

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

This method copies the image data to the created Leadtools.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 Leadtools.RasterImage object will need to be disposed.

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

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

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Public Sub ExportPageToRasterImageExample()
      Dim tifFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif")
      Dim exportedFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "OcrExported.jpg")
      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()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void ExportPageToRasterImageExample()
   {
      string tifFileName = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif");
      string exportedFileName = Path.Combine(LEAD_VARS.ImagesDir, "OcrExported.jpg");
      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();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

[TestMethod]
public async Task ExportPageToRasterImageExample()
{
   string tifFileName = @"Assets\Ocr1.tif";
   string exportedFileName = "OcrExported.jpg";
   RasterCodecs codecs = new RasterCodecs();

   // Create an instance of the engine
   IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Advantage, 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, String.Empty, Tools.OcrEnginePath);

   // Create an OCR document
   IOcrDocument ocrDocument = ocrEngine.DocumentManager.CreateDocument();

   // Add the image to the document
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(tifFileName);
   using (RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile)))
   {
      ocrDocument.Pages.AddPage(image, null);
   }

   // Export it back as a RasterImage
   RasterImage exportedImage = ocrDocument.Pages.ExportPage(0);

   // Save this image to disk
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(exportedFileName);
   await codecs.SaveAsync(exportedImage, LeadStreamFactory.Create(saveFile), RasterImageFormat.Jpeg, 0);

   // We need to dispose the image ourselves
   exportedImage.Dispose();

   // Shutdown the engine
   ocrEngine.Shutdown();

   codecs.Dispose();
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

IOcrPageCollection Interface
IOcrPageCollection Members
Overload List
OcrEngineManager Class
OcrEngineType Enumeration
IOcrPage Interface
Programming with the LEADTOOLS .NET OCR