LEADTOOLS Forms (Leadtools.Forms.DocumentWriters assembly)
LEAD Technologies, Inc

IDocumentOptions Interface






Members 
Abstract base class that provides functionality common to all the format option classes in the LEADTOOLS Document Writers. .NET support
Object Model
IDocumentOptions Interface
Syntax
public interface IDocumentOptions 
'Declaration
 
Public Interface IDocumentOptions 
'Usage
 
Dim instance As IDocumentOptions
public interface IDocumentOptions 
function Leadtools.Forms.DocumentWriters.IDocumentOptions() 
public interface class IDocumentOptions 
Remarks

Note: In LEADTOOLS for .NET, the equivalant to this class is the DocumentOptions class.

You cannot use the IDocumentOptions interface 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 classes 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 (2007/2010) 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 IDocumentOptions interface 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: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

IDocumentOptions Members
Leadtools.Forms.DocumentWriters Namespace
Document Writers
Programming with LEADTOOLS Document Writers
Files to be Included with Your Application
Unlocking Special LEAD Features

Abstract base class that provides functionality common to all the format option classes in the LEADTOOLS Document Writers. .NET support
Object Model
IDocumentOptions Interface
Syntax
public interface IDocumentOptions 
'Declaration
 
Public Interface IDocumentOptions 
'Usage
 
Dim instance As IDocumentOptions
public interface IDocumentOptions 
function Leadtools.Forms.DocumentWriters.IDocumentOptions() 
public interface class IDocumentOptions 
Remarks

Note: In LEADTOOLS for .NET, the equivalant to this class is the DocumentOptions class.

You cannot use the IDocumentOptions interface 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 classes 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 (2007/2010) 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 IDocumentOptions interface 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: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

IDocumentOptions Members
Leadtools.Forms.DocumentWriters Namespace
Document Writers
Programming with LEADTOOLS Document Writers
Files to be Included with Your Application
Unlocking Special LEAD Features

 

 


Products | Support | Contact Us | Copyright Notices

© 2006-2012 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