AddPage Method

Summary

Adds a new page to current document being created.

Syntax

Objective-C

C++/CLI

Java

Python

public void AddPage( 
   DocumentWriterPage page 
)

- (BOOL)addPage:(__kindof LTDocumentWriterPage *)page progress:(nullable LTDocumentWriterProgressHandler)progress error:(NSError **)error NS_SWIFT_NAME(add(_:progress:));

public void addPage(DocumentWriterPage page)

public: 
void AddPage(  
   DocumentWriterPage^ page 
)

def AddPage(self,page):

Parameters

page
The new page properties

Remarks

This method can be called multiple times for each page to be added to the new document. To create a new document and on information on how to use the DocumentWriter class, Refer to LEADTOOLS Document Writers for more information.

Depending on the type of the page, the SvgDocument, DocumentWriterEmfPage.EmfHandle or DocumentWriterRasterPage.Image property of the page parameter must contain a valid object. The DocumentWriterSvgPage.Image, DocumentWriterEmfPage.Image property is optional and is used only when the document being created is PDF with the Image/Text overlay option. To create a PDF document with image/text overlay, perform the following steps:

Set the value of the PdfDocumentOptions.ImageOverText to true. You can use the GetOptions and SetOptions methods to the get the options used when saving a PDF document.
Call BeginDocument with DocumentFormat.Pdf as the format to use.
Add the document pages, the DocumentWriterSvgPage.SvgDocument or DocumentWriterEmfPage.EmfHandle property must point to the SVG or EMF representation of the page respectively and the DocumentWriterSvgPage.Image or DocumentWriterEmfPage.Image must contain a RasterImage object for the image to be used as the overlay for the page.
Repeat for each page in the document.
Call EndDocument to finish creating the document file on disk.

AddPage will append the new page at the end of the document. To insert a page at a random place in the document, use InsertPage. Note that InsertPage is only supported if the was crated using the DocumentFormat.Ltd format.

For more information, refer to PdfDocumentOptions.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
using Leadtools.Ocr; 
 
 
public void DocumentWriterExample() 
{ 
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "test.docx"); 
   var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Example.pdf"); 
 
   // Setup a new RasterCodecs object 
   var codecs = new RasterCodecs(); 
   codecs.Options.RasterizeDocument.Load.Resolution = 300; 
 
   // Get the number of pages in the input document 
   var pageCount = codecs.GetTotalPages(inputFileName); 
 
   // Create a new instance of the LEADTOOLS Document Writer 
   var docWriter = new DocumentWriter(); 
 
   // Change the PDF options 
   var pdfOptions = docWriter.GetOptions(DocumentFormat.Pdf) as PdfDocumentOptions; 
   pdfOptions.DocumentType = PdfDocumentType.PdfA; 
   docWriter.SetOptions(DocumentFormat.Pdf, pdfOptions); 
 
   // Create a new PDF document 
   Debug.WriteLine("Creating new PDF document: {0}", outputFileName); 
   docWriter.BeginDocument(outputFileName, DocumentFormat.Pdf); 
 
   // Loop through all the pages 
   for (var pageNumber = 1; pageNumber <= pageCount; pageNumber++) 
   { 
      // Get the page as SVG 
      Debug.WriteLine("Loading page {0}", pageNumber); 
      var page = new DocumentWriterSvgPage(); 
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, null); 
 
      // Add the page 
      Debug.WriteLine("Adding page {0}", pageNumber); 
      docWriter.AddPage(page); 
 
      page.SvgDocument.Dispose(); 
   } 
 
   // Finally finish writing the PDF file on disk 
   docWriter.EndDocument(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}