Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Enum DocumentFormat Inherits Enum | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
| |
| C# | |
|---|---|
public enum DocumentFormat : Enum | |
| C++/CLI | |
|---|---|
public enum class DocumentFormat : public Enum | |
Members
| Member | Description |
|---|---|
| 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. |
| 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. |
| 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 RasterSupportType and Unlocking Special LEAD Features. | |
| Doc | Microsoft Word document format (DOC). LEADTOOLS Document Writers support extra options for the DOC format. For more information refer to DocDocumentOptions. |
| Rtf | Microsoft Rich Text Format (RTF). LEADTOOLS Document Writers support extra options for the RTF format. For more information refer to RtfDocumentOptions. |
| Html | HyperText Markup Language (HTML). LEADTOOLS Document Writers support several flavors with multiple options of 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. |
| 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. |
| 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. |
| Docx | Microsoft Word 2007 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 format. For more information refer to DocxDocumentOptions. |
Example
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 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, Emf, Html, Ltd, Rtf, Text and User | RasterSupportType.DocumentWriters |
| Pdf and Xps | RasterSupportType.DocumentWriters and RasterSupportType.DocumentWritersPdf |
Inheritance Hierarchy
System.Object
System.ValueType
System.Enum
Leadtools.Forms.DocumentWriters.DocumentFormat
Requirements
Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family