←Select platform

DocumentOptions Class

Summary

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

Syntax
C#
VB
Java
Objective-C
C++
[SerializableAttribute()] 
[DataContractAttribute()] 
public abstract class DocumentOptions 
<DataContractAttribute()> 
<SerializableAttribute()> 
Public MustInherit Class DocumentOptions  
@interface LTDocumentOptions : NSObject <NSCopying, NSCoding> // ABSTRACT 
public abstract class DocumentOptions 
[DataContractAttribute()] 
[SerializableAttribute()] 
public ref class DocumentOptions abstract  

Remarks

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

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
DocumentFormat.AltoXml AltoXmlDocumentOptions

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

  1. Call the DocumentWriter.GetOptions method for the DocumentWriter object being used, passing the DocumentFormat to be used in the format parameter. The resulting object from the base DocumentOptions class needs to be cast to the appropriate derived class described in the previous table.

  2. Use the various derived class properties to change the options.

  3. Call DocumentWriter.SetOptions to set the new options for the engine.

  4. Now call the DocumentWriter.BeginDocument method (using the DocumentFormat value for the format parameter) to create a new document and add the pages.

Example

For an example, refer to DocumentWriter.

Requirements

Target Platforms

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.Writer Assembly