BeginDocument Method

public void BeginDocument( 
   string fileName,
   DocumentFormat format
)

'Declaration
 
Public Sub BeginDocument( _
   ByVal fileName As String, _
   ByVal format As DocumentFormat _
) 

'Usage
 
Dim instance As DocumentWriter
Dim fileName As String
Dim format As DocumentFormat
 
instance.BeginDocument(fileName, format)

public void BeginDocument( 
   string fileName,
   DocumentFormat format
)

 function Leadtools.Forms.DocumentWriters.DocumentWriter.BeginDocument( 
   fileName ,
   format 
)

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

Parameters

fileName

The name of new document file.

format

The format of the new document.

The DocumentWriter and the LEADTOOLS Document Writers toolkit is used to create multi-page and searchable documents from one or more Windows Enhanced Meta File (EMF) objects.

Support for various popular formats is included, such as PDF, XPS, DOC, HTML, RTF or Text. For a list of all the document formats supported, refer to the DocumentFormat enumeration.

To create a document from EMF, perform the following steps:

• Create an instance of the DocumentWriter class.
• Optional: Set the document options required. For example, if you are planning to save the final document as PDF/A instead of the default PDF, use DocumentWriter.GetOptions to get an instance of the current PDF options stored in a PdfDocumentOptions object. Change the PdfDocumentOptions.DocumentType property to PdfDocumentType.Pdf. Finally set the options back with the DocumentWriter.SetOptions method.
• Optional: If progress monitor or abortion is required, subscribe to the DocumentWriter.Progress event.
• Creates a new document by calling the DocumentWriter.BeginDocument method with the requested output file name and format.
• Add the EMF objects as pages to the document. First create an instance of the DocumentPage structure, set the DocumentPage.EmfHandle property to the EMF for the first page, if you are creating a PDF file with the "image over text" overlay option, then set the DocumentPage.Image property to the overlay image for this page. Finally call DocumentWriter.AddPage to add the page to the current document.
• Repeat the step above for each page in your source document.
• Finally, call DocumentWriter.EndDocument to finalize the document and create it on disk.
• Note: You can use a DocumentWriter object to save one document at a time. Once you call DocumentWriter.BeginDocument, end the document first (by adding the pages and then call DocumentWriter.EndDocument before calling DocumentWriter.BeginDocument again to create a new document. Calling DocumentWriter.BeginDocument while a document is already being created will result in an exception being thrown.

The Windows Enhanced Meta File (EMF) objects can be obtained from various sources, for example:

• The LEADTOOLS Annotations toolkit has support for creating an EMF file representation of the annotation objects in a container. Therefore, you can use the Annotations toolkit to create a document and populate it with various annotations objects and then save the result as a PDF file for example using the DocumentWriter class. The Document Writer demo shipping with the LEADTOOLS Toolkit shows how an example on this scenario. For more information, refer to Programming With LEADTOOLS Annotations.
• The LEADTOOLS Virtual Printer Driver toolkit allows you to capture output from any Windows application as an EMF handle. You can then use the DocumentWriter class to convert this output to a PDF, HTML or a DOC document. For more information, refer to LEADTOOLS Virtual Printer Driver.
• The Windows Enhanced Meta File (EMF) is a standard format in Microsoft Windows. Many other applications and frameworks provide support for outputting as EMF. You can convert the output from any such application or framework to any of the document formats supported by the DocumentWriter.

Many of the document formats supported by DocumentWriter contain extra options and functionality that can be controlled through the use of the DocumentWriter.GetOptions and DocumentWriter.GetOptions methods. These options can be set and then saved to an external XML file using the DocumentWriter.SaveOptions method. Later, you can re-load these options using the DocumentWriter.LoadOptions method.

Support is provided to monitor the document creation operation through the DocumentWriter.Progress event. Your application can provide a visual feedback using a progress bar and a cancel button to the user to allow both monitoring and the ability to abort the current operation.

The LEADTOOLS Temporary Document format (DocumentFormat.Ltd) allows you to create a temporary document on disk that you can add pages to in between sessions. This can be helpful when you have large amount of pages to add to a PDF document when not all the pages can be obtained at the same time (for example, in a server scenario when the client sends one page to the server at a time). After all pages are added to the temporary file on disk, you can use the DocumentWriter.Convert method to convert this file to the final document (for example PDF or DOC).

You can also use the DocumentWriter.AppendLtd method to append pages from one LTD file to another.

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DocumentWriter Class
DocumentWriter Members
DocumentPage Structure
DocumentFormat Enumeration
Programming with LEADTOOLS Document Writers
Files to be Included with Your Application
Unlocking Special LEAD Features