ExportPages(Int32,Int32,Stream,RasterImageFormat,Int32,Int32,CodecsSavePageMode) Method

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

void ExportPages( 
   int firstPageIndex,
   int lastPageIndex,
   Stream stream,
   RasterImageFormat format,
   int bitsPerPixel,
   int firstSavePageNumber,
   CodecsSavePageMode pageMode
)

'Declaration
 
Overloads Sub ExportPages( _
   ByVal firstPageIndex As Integer, _
   ByVal lastPageIndex As Integer, _
   ByVal stream As Stream, _
   ByVal format As RasterImageFormat, _
   ByVal bitsPerPixel As Integer, _
   ByVal firstSavePageNumber As Integer, _
   ByVal pageMode As CodecsSavePageMode _
)

'Usage
 
Dim instance As IOcrPageCollection
Dim firstPageIndex As Integer
Dim lastPageIndex As Integer
Dim stream As Stream
Dim format As RasterImageFormat
Dim bitsPerPixel As Integer
Dim firstSavePageNumber As Integer
Dim pageMode As CodecsSavePageMode
 
instance.ExportPages(firstPageIndex, lastPageIndex, stream, format, bitsPerPixel, firstSavePageNumber, pageMode)

void ExportPages( 
   int firstPageIndex,
   int lastPageIndex,
   Stream stream,
   RasterImageFormat format,
   int bitsPerPixel,
   int firstSavePageNumber,
   CodecsSavePageMode pageMode
)

function Leadtools.Forms.Ocr.IOcrPageCollection.ExportPages(Int32,Int32,Stream,RasterImageFormat,Int32,Int32,CodecsSavePageMode)( 
   firstPageIndex ,
   lastPageIndex ,
   stream ,
   format ,
   bitsPerPixel ,
   firstSavePageNumber ,
   pageMode 
)

void ExportPages( 
   int firstPageIndex,
   int lastPageIndex,
   Stream^ stream,
   RasterImageFormat format,
   int bitsPerPixel,
   int firstSavePageNumber,
   CodecsSavePageMode pageMode
)

Parameters

firstPageIndex

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

lastPageIndex

The zero-based index of the last page to export. A value of -1 means export up to and including the last page in the OCR document.

stream

The .NET stream to save the pages to.

format

The image file format to use.

bitsPerPixel

The bits/pixel value of the result image file.

firstSavePageNumber

1-based index of the first output page. If the output file already exists, then this parameter lets you control which pages to overwrite and/or where to append the new pages.

pageMode

Determines how to handle the page when saving to multipage formats. This can be one of the following:

Value	Meaning
CodecsSavePageMode.Append	Append the new page(s) to the end of the file. If the file does not exist, this option will create the file and add the pages to it. firstSavePageNumber is not used.
CodecsSavePageMode.Insert	Insert the new page(s) at the index specified by firstSavePageNumber.
CodecsSavePageMode.Replace	Replace the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.Overwrite	Overwrite the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.Append	Append the new page(s) to the end of the file. If the file does not exist, this option will create the file and add the pages to it.

To export one page to a .NET stream, use ExportPages(int pageIndex, Stream stream, RasterImageFormat format, int bitsPerPixel)

.

You can export the page to any of the file formats supported by LEADTOOLS. For more information, refer to Summary of All Supported Image File Formats.

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

Copy Code

Public Sub ExportPagesToStream()
      Dim imagesPath As String = LEAD_VARS.ImagesDir
      Dim tifFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "OcrMultiPage.tif")
      ' 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(Nothing, Nothing, Nothing, Nothing)

         ' Create an OCR document
         Using ocrDocument As IOcrDocument = ocrEngine.DocumentManager.CreateDocument()

            ' Loop through the images, add them to the document
            For i As Integer = 0 To 3
               Dim pageFileName As String = Path.Combine(imagesPath, String.Format("Ocr{0}.tif", i + 1))
               ocrDocument.Pages.AddPage(pageFileName, Nothing)
            Next

            Console.WriteLine("OCR document contains {0} pages", ocrDocument.Pages.Count)

            ' Export the pages from index 1 to 3 to disk
            Using fs As FileStream = File.Create(tifFileName)
               ocrDocument.Pages.ExportPages(1, 3, fs, RasterImageFormat.Tif, 1, 1, CodecsSavePageMode.Overwrite)
            End Using
         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

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

public void ExportPagesToStream()
   {
      string tifFileName = Path.Combine(LEAD_VARS.ImagesDir, "OcrMultiPage.tif");
      // 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(null, null, null, null);

         // Create an OCR document
         using(IOcrDocument ocrDocument = ocrEngine.DocumentManager.CreateDocument())
         {
            // Loop through the images, add them to the document
            for(int i = 0; i < 4; i++)
            {
               string pageFileName = Path.Combine(LEAD_VARS.ImagesDir, string.Format("Ocr{0}.tif", i + 1));
               ocrDocument.Pages.AddPage(pageFileName, null);
            }

            Console.WriteLine("OCR Document contains {0} pages", ocrDocument.Pages.Count);

            // Export the pages from index 1 to 3 to disk
            using(FileStream fs = File.Create(tifFileName))
            {
               ocrDocument.Pages.ExportPages(1, 3, fs, RasterImageFormat.Tif, 1, 1, CodecsSavePageMode.Overwrite);
            }
         }

         // Shutdown the engine
         // Note: calling Dispose will also automatically shutdown the engine if it has been started
         ocrEngine.Shutdown();
      }
   }

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

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
Summary of All Supported Image File Formats