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



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.
fileName
The name of the file 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:

ValueMeaning
CodecsSavePageMode.AppendAppend 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.InsertInsert the new page(s) at the index specified by firstSavePageNumber.
CodecsSavePageMode.ReplaceReplace the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.OverwriteOverwrite the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.AppendAppend 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.

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.
fileName
The name of the file 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:

ValueMeaning
CodecsSavePageMode.AppendAppend 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.InsertInsert the new page(s) at the index specified by firstSavePageNumber.
CodecsSavePageMode.ReplaceReplace the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.OverwriteOverwrite the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.AppendAppend 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.

Exports one of more page at the specified index to a disk file.

Syntax

Visual Basic (Declaration) 
Overloads Overridable Sub ExportPages( _
   ByVal firstPageIndex As Integer, _
   ByVal lastPageIndex As Integer, _
   ByVal fileName As String, _
   ByVal format As RasterImageFormat, _
   ByVal bitsPerPixel As Integer, _
   ByVal firstSavePageNumber As Integer, _
   ByVal pageMode As CodecsSavePageMode _
) 
Visual Basic (Usage)Copy Code
Dim instance As IOcrPageCollection
Dim firstPageIndex As Integer
Dim lastPageIndex As Integer
Dim fileName As String
Dim format As RasterImageFormat
Dim bitsPerPixel As Integer
Dim firstSavePageNumber As Integer
Dim pageMode As CodecsSavePageMode
 
instance.ExportPages(firstPageIndex, lastPageIndex, fileName, format, bitsPerPixel, firstSavePageNumber, pageMode)
C# 
virtual void ExportPages( 
   int firstPageIndex,
   int lastPageIndex,
   string fileName,
   RasterImageFormat format,
   int bitsPerPixel,
   int firstSavePageNumber,
   CodecsSavePageMode pageMode
)
C++/CLI 
virtual void ExportPages( 
   int firstPageIndex,
   int lastPageIndex,
   String^ fileName,
   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.
fileName
The name of the file 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:

ValueMeaning
CodecsSavePageMode.AppendAppend 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.InsertInsert the new page(s) at the index specified by firstSavePageNumber.
CodecsSavePageMode.ReplaceReplace the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.OverwriteOverwrite the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.AppendAppend 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.

Example

This example will add pages to an OCR document before exporting a range of it back to disk to a multi-page file.

Visual BasicCopy Code
Public Sub ExportPagesToFile()
   ' 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 tifFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "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 4
            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
         ocrDocument.Pages.ExportPages(1, 3, tifFileName, RasterImageFormat.Tif, 1, 1, CodecsSavePageMode.Overwrite)
      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 ExportPagesToFile() 

   // 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 tifFileName = LeadtoolsExamples.Common.ImagesPath.Path + "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(imagesPath, 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 
         ocrDocument.Pages.ExportPages(1, 3, tifFileName, 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(); 
   } 
}

Remarks

To export one page to a disk file, use ExportPages(int pageIndex, string fileName, 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.

Requirements

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

See Also

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