DocumentWriterRasterPage Class

Summary

Data for one raster page to be added to a document file.

Syntax

Objective-C

C++/CLI

Java

Python

public class DocumentWriterRasterPage : DocumentWriterPage

@interface LTDocumentWriterRasterPage : LTDocumentWriterPage<NSCopying>

public class DocumentWriterRasterPage extends DocumentWriterPage

public ref class DocumentWriterRasterPage : public DocumentWriterPage

class DocumentWriterRasterPage(DocumentWriterPage):

Remarks

The DocumentWriterRasterPage structure contains the data for one raster image page to be added to a document file. It is used as a parameter to the DocumentWriter.AddPage or DocumentWriter.InsertPage methods used to add the page.

The DocumentWriterRasterPage.Image property must contain a valid raster image (RasterImage) object that contains the visual representation of the page. This image object can obtained through multiple sources as explained in LEADTOOLS Document Writers.

DocumentWriterRasterPage.Image is used as is when DocumentWriter.AddPage or DocumentWriter.InsertPage is called and the framework does not delete it. You must dispose the object when it is no longer used.

The LEADTOOLS Document Writer supports creating documents with zero or more empty pages inside them. Use DocumentWriter.AddPage or DocumentWriter.InsertPage with an DocumentWriterEmptyPage with the dimension of the empty page set before hand in the DocumentOptions.EmptyPageWidth and DocumentOptions.EmptyPageHeight and its resolution set to DocumentOptions.EmptyPageResolution. As many empty pages as desired can be added in any index desired. To use empty pages, make sure the DocumentOptions.PageRestriction property is set to DocumentPageRestriction.Relaxed.

For more information, refer to PdfDocumentOptions.

Example

This example will create a PDF document with first page from SVG data, second page empty and third page from raster image.

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
using Leadtools.Ocr; 
 
 
public void DocumentRasterPageExample() 
{ 
   // Input file name 
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "TEST.docx"); 
 
   // Output PDF file name 
   var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "out_Example.pdf"); 
 
   // Create a new instance of the LEADTOOLS Document Writer 
   var docWriter = new DocumentWriter(); 
 
   // Setup a new RasterCodecs object 
   using (var codecs = new RasterCodecs()) 
   { 
      codecs.Options.RasterizeDocument.Load.Resolution = 300; 
 
      // Get information on the page 
      double pageWidth; 
      double pageHeight; 
      using (var info = codecs.GetInformation(inputFileName, false, 1)) 
      { 
         // Get the size in inches, we need it for the empty page 
         pageWidth = info.Document.PageWidth; 
         pageHeight = info.Document.PageHeight; 
      } 
 
      // Begin the document 
      docWriter.BeginDocument(outputFileName, DocumentFormat.Pdf); 
 
      // Add the first page from SVG 
      var svgPage = new DocumentWriterSvgPage(); 
      using (svgPage.SvgDocument = codecs.LoadSvg(inputFileName, 1, null)) 
      { 
         // Add it 
         docWriter.AddPage(svgPage); 
      } 
 
      // Add a second page as empty 
      var emptyPage = new DocumentWriterEmptyPage(); 
      emptyPage.Width = pageWidth; 
      emptyPage.Height = pageHeight; 
      docWriter.AddPage(emptyPage); 
 
      // Finally, add a third page as an image 
      var rasterPage = new DocumentWriterRasterPage(); 
      using (rasterPage.Image = codecs.Load(inputFileName, 1)) 
      { 
         // Add it 
         docWriter.AddPage(rasterPage); 
      } 
   } 
 
   // Finally finish writing the HTML file on disk 
   docWriter.EndDocument(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
 
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.codecs.*; 
import leadtools.document.writer.*; 
 
 
public void documentRasterPageExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String inputFileName = combine(LEAD_VARS_IMAGES_DIR, "LEADTOOLSEditor.docx"); 
   String outputFileName = combine(LEAD_VARS_IMAGES_DIR, "DocumentRasterExample.pdf"); 
 
   // Create a new instance of the LEADTOOLS Document Writer 
   DocumentWriter docWriter = new DocumentWriter(); 
 
   // Setup a new RasterCodecs object 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.getOptions().getRasterizeDocument().getLoad().setResolution(300); 
 
   // Get information on the page 
   double pageWidth; 
   double pageHeight; 
   CodecsImageInfo info = codecs.getInformation(inputFileName, false, 1); 
 
   // Get the size in inches, we need it for the empty page 
   pageWidth = info.getDocument().getPageWidth(); 
   pageHeight = info.getDocument().getPageHeight(); 
   info = null; 
 
   // Begin the document 
   docWriter.beginDocument(outputFileName, DocumentFormat.PDF); 
 
   // Add the first page from SVG 
   DocumentWriterSvgPage svgPage = new DocumentWriterSvgPage(); 
   svgPage.setSvgDocument(codecs.loadSvg(inputFileName, 1, null)); 
 
   // Add it 
   docWriter.addPage(svgPage); 
   svgPage.setSvgDocument(null); 
 
   // Add a second page as empty 
   DocumentWriterEmptyPage emptyPage = new DocumentWriterEmptyPage(); 
   emptyPage.setWidth(pageWidth); 
   emptyPage.setHeight(pageHeight); 
   docWriter.addPage(emptyPage); 
 
   assertTrue(emptyPage.getWidth() == pageWidth); 
   assertTrue(emptyPage.getHeight() == pageHeight); 
 
   // Finally, add a third page as an image 
   DocumentWriterRasterPage rasterPage = new DocumentWriterRasterPage(); 
   rasterPage.setImage(codecs.load(inputFileName, 1)); 
 
   // Add it 
   docWriter.addPage(rasterPage); 
   rasterPage.setImage(null); 
 
   // Finally finish writing the HTML file on disk 
   docWriter.endDocument(); 
   assertTrue((new File(outputFileName)).exists()); 
}