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



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

Abstract base class that provides functionality common to all the format option classes in the LEADTOOLS Document Writers.

Object Model

DocumentOptions Class

Syntax

Visual Basic (Declaration) 
Public MustInherit Class DocumentOptions 
Visual Basic (Usage)Copy Code
Dim instance As DocumentOptions
C# 
public abstract class DocumentOptions 
C++/CLI 
public ref class DocumentOptions abstract 

Example

For an example, refer to DocumentWriter.

Remarks

You cannot use the DocumentOptions class directly. Instead, use one of the derived classes to get and set the options associated with a document format. The following table lists the document formats and the DocumentOptions derived class associated with it:

Format Class
DocumentFormat.Ltd LtdDocumentOptions
DocumentFormat.Pdf PdfDocumentOptions
DocumentFormat.Doc DocDocumentOptions
DocumentFormat.Rtf RtfDocumentOptions
DocumentFormat.Html HtmlDocumentOptions
DocumentFormat.Text TextDocumentOptions
DocumentFormat.Emf EmfDocumentOptions
DocumentFormat.Xps XpsDocumentOptions
DocumentFormat.Docx DocxDocumentOptions
DocumentFormat.Xls XpsDocumentOptions

To change the options used with a particular format, perform the following steps:

  1. Use the DocumentWriter.GetOptions method for the DocumentWriter object you are using, passing DocumentFormat desired in to the format parameter. The resulting object from the base DocumentOptions class needs to be cast to an appropriate derived class described in the previous table.
  2. Use the various derived class properties to change the options.
  3. Use DocumentWriter.SetOptions to set the new options for the engine.
  4. Now call the DocumentWriter.BeginDocument method (using the desired DocumentFormat value for the format parameter) to create a new document and add the pages.

Inheritance Hierarchy

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