ExportPage(int,string,RasterImageFormat,int) Method

Summary

Export the page at the specified index to a disk file.

Syntax

Objective-C

C++/CLI

Python

public void ExportPage( 
   int pageIndex, 
   string fileName, 
   RasterImageFormat format, 
   int bitsPerPixel 
)

- (BOOL)exportPageAtIndex:(NSUInteger)pageIndex 
                     file:(NSString *)fileName 
                   format:(LTRasterImageFormat)format 
             bitsPerPixel:(NSUInteger)bitsPerPixel 
                    error:(NSError **)error

void ExportPage(  
   int pageIndex, 
   String^ fileName, 
   RasterImageFormat format, 
   int bitsPerPixel 
)

def ExportPage(self,pageIndex,fileName,format,bitsPerPixel):

Parameters

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

fileName
The name of the file to save the page to.

format
The image file format to use.

bitsPerPixel
The bits/pixel value of the result image file.

Remarks

To export more than one page to a multipage disk file, use ExportPages(int firstPageIndex, int lastPageIndex, string fileName, RasterImageFormat format, int bitsPerPixel, int firstSavePageNumber, CodecsSavePageMode pageMode).

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.

This member only works with memory-based documents and will throw an exception otherwise. For more information, refer to IOcrDocumentManager.CreateDocument and Programming with the LEADTOOLS .NET OCR.

Example

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

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Ocr; 
using Leadtools.Document.Writer; 
using Leadtools.Forms.Common; 
using Leadtools.ImageProcessing.Core; 
 
public void ExportPageToFile() 
{ 
   string tifFileName = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif"); 
   string exportedFileName = Path.Combine(LEAD_VARS.ImagesDir, "OcrExported.jpg"); 
 
   // Create an instance of the engine 
   using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD)) 
   { 
      // 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, LEAD_VARS.OcrLEADRuntimeDir); 
 
      // Create an OCR document 
      using (IOcrDocument ocrDocument = ocrEngine.DocumentManager.CreateDocument()) 
      { 
         // Add the image to the document 
         ocrDocument.Pages.AddPage(tifFileName, null); 
 
         // Save it to disk 
         ocrDocument.Pages.ExportPage(0, exportedFileName, RasterImageFormat.Jpeg, 0); 
      } 
 
      // 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:\LEADTOOLS23\Resources\Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS23\Bin\Common\OcrLEADRuntime"; 
}

 
import java.io.File; 
import java.io.IOException; 
import java.net.URI; 
import java.net.URISyntaxException; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.document.writer.DocumentFormat; 
import leadtools.imageprocessing.core.DeskewCommand; 
import leadtools.imageprocessing.core.DeskewCommandFlags; 
import leadtools.ocr.OcrDocument; 
import leadtools.ocr.OcrEngine; 
import leadtools.ocr.OcrEngineManager; 
import leadtools.ocr.OcrEngineType; 
 
 
public void IOcrPageCollectionsExportPageToFile() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   final String LEAD_VARS_OCR_LEAD_RUNTIME_DIR = "C:\\LEADTOOLS23\\Bin\\Common\\OcrLEADRuntime"; 
   String tifFileName = combine(LEAD_VARS_IMAGES_DIR, "Ocr1.tif"); 
   String exportedFileName = combine(LEAD_VARS_IMAGES_DIR, "OcrExported.jpg"); 
 
   // Create an instance of the engine 
   OcrEngine ocrEngine = OcrEngineManager.createEngine(OcrEngineType.LEAD); 
 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // 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, LEAD_VARS_OCR_LEAD_RUNTIME_DIR); 
   assertTrue("Engine unsuccessfully started", ocrEngine.isStarted()); 
 
   // Create an OCR document 
   OcrDocument ocrDocument = ocrEngine.getDocumentManager().createDocument(); 
 
   // Add the image to the document 
   RasterImage image = codecs.load(tifFileName); 
   ocrDocument.getPages().addPage(image, null); 
 
   // Save it to disk 
   ILeadStream ls = LeadStreamFactory.create(exportedFileName); 
   ocrDocument.getPages().exportPage(0, ls, RasterImageFormat.JPEG, 0); 
   assertTrue("File unsuccessfully saved", (new File(exportedFileName)).exists()); 
 
   // Shutdown the engine 
   // Note: calling Dispose will also automatically shutdown the engine if it has 
   // been started 
   ocrEngine.dispose(); 
}