DocumentFormat Enumeration

Specifies the output document formats supported by the LEADTOOLS Document Writers.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public enum DocumentFormat : System.Enum, System.IComparable, System.IConvertible, System.IFormattable

'Declaration
 
Public Enum DocumentFormat 
   Inherits System.Enum
   Implements System.IComparable, System.IConvertible, System.IFormattable

'Usage
 
Dim instance As DocumentFormat

public enum DocumentFormat : System.IComparable, System.IConvertible, System.IFormattable

Leadtools.Forms.DocumentWriters.DocumentFormat = function() { };
Leadtools.Forms.DocumentWriters.DocumentFormat.prototype = {

  LeadtoolsMemberMarker(replace me)
 };

public enum class DocumentFormat : public System.Enum, System.IComparable, System.IConvertible, System.IFormattable

Members

Member	Description
Doc	Microsoft Word 2003 document format (DOC). LEADTOOLS Document Writers support extra options for the DOC format. For more information refer to DocDocumentOptions.
Docx	Microsoft Word 2007/2010 document format (DOCX) (this format requires .NET Framework 3.0 and Microsoft Open XML Format SDK 1.0.). LEADTOOLS Document Writers support extra options for the DOCX(2007/2010) format. For more information refer to DocxDocumentOptions.
Emf	Windows Enhanced Meta File (EMF). EMF format does not support multi-page documents. Therefore, only the last page added with the DocumentWriter.AddPage will be used in the final document.
Html	HyperText Markup Language (HTML). LEADTOOLS Document Writers support several flavors with multiple options of the RTF format. For more information refer to RtfDocumentOptions.
Ltd	LEADTOOLS Temporary Document. This format creates a temporary file on disk that can later be converted to any of the other formats supported by the LEADTOOLS Document Writers. This format supports appending pages to an existing file, therefore, you can use the Ltd format if you have large amount of pages to convert over multiple sessions. When calling the DocumentWriter.BeginDocument method with the Ltd document format, the toolkit will check if the output file specified exists on disk. If it does, the new pages will be appended to the end of the file. When you are finished adding all the pages use the DocumentWriter.Convert method to convert this temporary file to the desired output format.
Pdf	Adobe Portable Document Format (PDF). LEADTOOLS Document Writers support several flavors with multiple options of the PDF format, for more information refer to PdfDocumentOptions. Note: The PDF document support requires unlocking an extra key before it can be used. For more information, refer to Leadtools.RasterSupportType and Unlocking Special LEAD Features.
Rtf	Microsoft Rich Text Format (RTF). LEADTOOLS Document Writers support extra options for the RTF format. For more information refer to RtfDocumentOptions.
Text	Text format. LEADTOOLS Document Writers support extra options for the Text format. For more information refer to TextDocumentOptions.
User	User-defined document format. The User document format is not used inside the LEADTOOLS Document Writers toolkit. An exception will be thrown if User is used as an output document format in the DocumentWriter.BeginDocument method. The User format can however be used as an output format when used in the LEADTOOLS OCR toolkit as a special case to instruct the OCR framework to save the document using the engine native format.
Xls	Microsoft Excel 2003 format (XLS). LEADTOOLS Document Writers support extra options for the XLS format. For more information refer to XlsDocumentOptions.
Xps	Microsoft Open XML Paper Specification (XPS) (this format requires .NET Framework 3.0). LEADTOOLS Document Writers support extra options for the XPS format. For more information refer to XpsDocumentOptions.

Remarks

The DocumentFormat enumeration specifies the output format for the final document created with the LEADTOOLS Document Writers. Pass the format that are desired to the DocumentWriter.BeginDocument method.

To get or set the extra options supported by a format, use the DocumentWriter.GetOptions and DocumentWriter.SetOptions methods.

Some of the document formats require a special key to unlock. When using these formats unlock the specified support using the Leadtools.RasterSupport class first.

The following table lists the document formats and the support type required to be unlocked before using them:

Document Format	Support Type
Doc, Docx(2007/2010), Emf, Html, Ltd, Rtf, Text and User	RasterSupportType.DocumentWriters
Pdf and Xps	RasterSupportType.DocumentWriters and RasterSupportType.DocumentWritersPdf

Note: Not all formats are supported in the .NET and Windows Runtime. Use DocumentWriter.GetSupportedFormats to find the current level of support.

Example

For an example, refer to DocumentWriter.

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         Leadtools.Forms.DocumentWriters.DocumentFormat

Requirements

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

Leadtools.Forms.DocumentWriters Namespace
DocumentWriter Class
Programming with LEADTOOLS Document Writers
Files to be Included with Your Application
Unlocking Special LEAD Features