LEADTOOLS Forms (Leadtools.Forms.DocumentWriters assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
BeginDocument Method
See Also 
Leadtools.Forms.DocumentWriters Namespace > DocumentWriter Class : BeginDocument Method



fileName
The name of new document file.
format
The format of the new document.

The BeginDocument Method is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

fileName
The name of new document file.
format
The format of the new document.
Creates a new document and prepares it for the new pages to be added.

Syntax

Visual Basic (Declaration) 
Public Sub BeginDocument( _
   ByVal fileName As String, _
   ByVal format As DocumentFormat _
) 
Visual Basic (Usage)Copy Code
Dim instance As DocumentWriter
Dim fileName As String
Dim format As DocumentFormat
 
instance.BeginDocument(fileName, format)
C# 
public void BeginDocument( 
   string fileName,
   DocumentFormat format
)
C++/CLI 
public:
void BeginDocument( 
   String^ fileName,
   DocumentFormat format
) 

Parameters

fileName
The name of new document file.
format
The format of the new document.

Example

For an example, refer to DocumentWriter.

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:

  • 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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

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