BeginDocument(string,DocumentFormat) Method

Summary

Creates a new document file and prepares it for the new pages to be added.

Syntax

Objective-C

C++/CLI

Java

Python

public void BeginDocument( 
   string fileName, 
   DocumentFormat format 
)

- (BOOL)beginDocumentWithFileName:(NSString *)fileName  
                           format:(LTDocumentFormat)format  
                         progress:(nullable LTDocumentWriterProgressHandler)progress  
                            error:(NSError **)error

public void beginDocument(String fileName, DocumentFormat format)

public: 
void BeginDocument(  
   String^ fileName, 
   DocumentFormat format 
)

def BeginDocument(self,fileName,format):

Parameters

fileName
The name of the new document file.

format
The format of the new document.

Remarks

Use the DocumentWriter class to create multipage and searchable documents from one or more SVG, EMF, or raster image-based pages by calling the following functions:

Refer to LEADTOOLS Document Writers for more information.

Various popular formats are supported, including PDF, DOC/DOCX, XPS, HTML, RTF, and Text. For a list of all the document formats supported, refer to the DocumentFormat enumeration.

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"; 
}