BeginDocument(Stream,DocumentFormat) Method

Summary

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

Syntax

C++

public void BeginDocument( 
   Stream stream, 
   DocumentFormat format 
)

Public Sub BeginDocument( 
   ByVal stream As Stream, 
   ByVal format As DocumentFormat 
)

public:  
   void BeginDocument( 
      Stream^ stream, 
      DocumentFormat^ format 
   )

Parameters

stream

The stream that will contain the new document file.

format

The format of the new document.

Remarks

Note that the DocumentWriter object does not own stream and it should be kept alive between calls to BeginDocument and EndDocument. The DocumentWriter object can only be disposed by the user after EndDocument is finished.

Use the DocumentWriter class to create multipage and searchable documents from one or more SVG, EMF, or raster image-based pages, as follows:

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.

For an example of creating documents from EMF objects, refer to DocumentWriterEmfPage.

For an example of creating mixed documents from SVG, EMF, and empty pages; refer to DocumentWriterRasterPage.

Example

This example shows how to create a document stream from SVG-based pages using the basic functionality of the DocumentWriter class.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
using Leadtools.Ocr; 
 
public void DocumentWriterStreamExample() 
{ 
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.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 stream 
   using (Stream stream = new MemoryStream()) 
   { 
      docWriter.BeginDocument(stream, DocumentFormat.Pdf); 
 
      // Loop through all the pages 
      for (var pageNumber = 1; pageNumber <= pageCount; pageNumber++) 
      { 
         // Get the page as SVG 
         Console.WriteLine("Loading page {0}", pageNumber); 
         var page = new DocumentWriterSvgPage(); 
         page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, null); 
 
         // Add the page 
         Console.WriteLine("Adding page {0}", pageNumber); 
         docWriter.AddPage(page); 
 
         page.SvgDocument.Dispose(); 
      } 
 
      // Finally finish writing the PDF file on disk 
      docWriter.EndDocument(); 
      codecs.Dispose(); 
 
      // Save the stream to the output file 
      stream.Seek(0, SeekOrigin.Begin); 
      using (var fileStream = File.Create(outputFileName)) 
         stream.CopyTo(fileStream); 
 
      Console.WriteLine("Creating new PDF document: {0}", outputFileName); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Document.Writer 
Imports Leadtools.Ocr 
 
Public Sub DocumentWriterStreamExample() 
   Dim inputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.docx") 
   Dim outputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Example.pdf") 
 
   ' Setup a New RasterCodecs object 
   Dim codecs As New RasterCodecs() 
   codecs.Options.RasterizeDocument.Load.Resolution = 300 
 
   ' Get the number of pages in the input document 
   Dim pageCount As Integer = codecs.GetTotalPages(inputFileName) 
 
   ' Create a New instance of the LEADTOOLS Document Writer 
   Dim docWriter As New DocumentWriter() 
 
   ' Change the PDF options 
   Dim pdfOptions As PdfDocumentOptions = DirectCast(docWriter.GetOptions(DocumentFormat.Pdf), PdfDocumentOptions) 
   pdfOptions.DocumentType = PdfDocumentType.PdfA 
   docWriter.SetOptions(DocumentFormat.Pdf, pdfOptions) 
 
   ' Create a New PDF document stream 
   Using stream As New MemoryStream() 
      docWriter.BeginDocument(stream, DocumentFormat.Pdf) 
 
      ' Loop through all the pages 
      For pageNumber As Integer = 1 To pageCount 
         ' Get the page as SVG 
         Console.WriteLine("Loading page {0}", pageNumber) 
         Dim page As New DocumentWriterSvgPage() 
         page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, Nothing) 
 
         ' Add the page 
         Console.WriteLine("Adding page {0}", pageNumber) 
         docWriter.AddPage(page) 
 
         page.SvgDocument.Dispose() 
      Next 
 
      ' Finally finish writing the PDF file on disk 
      docWriter.EndDocument() 
      codecs.Dispose() 
 
      ' Save the stream to the output file 
      stream.Seek(0, SeekOrigin.Begin) 
      Using fileStream As Stream = File.Create(outputFileName) 
         stream.CopyTo(fileStream) 
      End Using 
 
      Console.WriteLine("Creating new PDF document: {0}", outputFileName) 
   End Using 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

DocumentWriter Class

DocumentWriter Members

Leadtools.Document.Writer Namespace

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.Document.Writer Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document.Writer Namespace

Assemblies