LEADTOOLS Forms (Leadtools.Forms.DocumentWriters assembly)

BeginDocument Method

Show in webframe







The name of new document file.
The format of the new document.
Creates a new document and prepares it for the new pages to be added.
Syntax
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.
Remarks

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:

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

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.

Example
For an example, refer to DocumentWriter.
Requirements

Target Platforms

See Also

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

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.

Leadtools.Forms.DocumentWriters requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features