GetOptions Method

Gets the extra options to use when saving a document using the specified format.

public DocumentOptions GetOptions( 
   DocumentFormat format 
) 

Public Function GetOptions( _ 
   ByVal format As DocumentFormat _ 
) As DocumentOptions 

- (LTDocumentOptions *)optionsForFormat:(LTDocumentFormat)format 

public DocumentOptions getOptions(DocumentFormat format) 

public: 
DocumentOptions^ GetOptions(  
   DocumentFormat format 
)  

Parameters

Return Value

The document options for this format. Note that the returned object from the base DocumentOptions class needs to be cast to one of the derived classes based on format.

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 DocumentOptions derived class associated with it:

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 in the engine.
4. Now you can call the DocumentWriter.BeginDocument method (with the desired DocumentFormat for the format parameter) to create a new document and add the pages.

For an example, refer to DocumentWriter.

Target Platforms

Reference

DocumentWriter Class

DocumentWriter Members

DocumentWriterPage Class

DocumentFormat Enumeration

Programming with LEADTOOLS Document Writers

Files to be Included with Your Application

Unlocking Special LEAD Features