LEADTOOLS Forms (Leadtools.Forms.DocumentWriters assembly)

GetOptions Method

Show in webframe







The document format.
Gets the extra options to use when saving a document using the specified format.
Syntax
public IDocumentOptions GetOptions( 
   DocumentFormat format
)
'Declaration
 
Public Function GetOptions( _
   ByVal format As DocumentFormat _
) As IDocumentOptions
'Usage
 
Dim instance As DocumentWriter
Dim format As DocumentFormat
Dim value As IDocumentOptions
 
value = instance.GetOptions(format)
public IDocumentOptions GetOptions( 
   DocumentFormat format
)

            

            
 function Leadtools.Forms.DocumentWriters.DocumentWriter.GetOptions( 
   format 
)
public:
IDocumentOptions^ GetOptions( 
   DocumentFormat format
) 

Parameters

format
The document format.

Return Value

The document options for this format. Note that the returned object from the IDocumentOptions interface needs to be cast to one of the derived classes based on format.
Remarks

You cannot use the IDocumentOptions 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 IDocumentOptions implementation class associated with it:

Format (the value of format) Class
DocumentFormat.Ltd LtdDocumentOptions
DocumentFormat.Pdf PdfDocumentOptions
DocumentFormat.Doc DocDocumentOptions
DocumentFormat.Rtf RtfDocumentOptions
DocumentFormat.Html HtmlDocumentOptions
DocumentFormat.Text TextDocumentOptions
DocumentFormat.Emf EmfDocumentOptions
DocumentFormat.Text TextDocumentOptions

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

  1. Use the DocumentWriter.GetOptions method of the DocumentWriter being used, passing DocumentFormat desired in to the format parameter. Note that the resulting object from the base DocumentOptions class needs to be cast to appropriate derived class described in the table above.
  2. Use the various derived class properties to change the options.
  3. Use 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.
Example
For an example, refer to DocumentWriter.
Requirements

Target Platforms

See Also

Reference

DocumentWriter Class
DocumentWriter Members
DocumentPage Structure
DocumentFormat Enumeration
Programming with LEADTOOLS Document Writers
Files to be Included with Your Application
Unlocking Special LEAD Features

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.

Leadtools.Forms.DocumentWriters requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features