←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

Note: In LEADTOOLS for Windows Runtime, the equivalent to this class is the DocumentOptions interface.

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.

Example

For an example, refer to DocumentWriter.

Requirements

Target Platforms

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Forms.DocumentWriters Assembly