←Select platform

XlsDocumentOptions Class

Summary

Provides extra options to use when saving a document using the Microsoft Excel 2003 format (XLS).

Syntax

C#
VB
Java
C++
[SerializableAttribute()] 
[DataContractAttribute()] 
public class XlsDocumentOptions : DocumentOptions 
<DataContractAttribute()> 
<SerializableAttribute()> 
Public Class XlsDocumentOptions  
   Inherits Leadtools.Forms.Documentwriters.DocumentOptions 
public class XlsDocumentOptions extends DocumentOptions 
[DataContractAttribute()] 
[SerializableAttribute()] 
public ref class XlsDocumentOptions : public Leadtools.Forms.Documentwriters.DocumentOptions

Remarks

The options set in the XlsDocumentOptions class will be used when the user saves a document using the DocumentFormat.Xls format.

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

  1. Use the DocumentWriter.GetOptions method of the DocumentWriter object being used, passing DocumentFormat.Xls to the format parameter. Note the resulting object from the base DocumentOptions class needs to be cast to XlsDocumentOptions.
  2. Use the various XlsDocumentOptions properties to change the options.
  3. Use DocumentWriter.SetOptions to set the new options in the engine.
  4. Now call the DocumentWriter.BeginDocument method (with DocumentFormat.Xls for the format parameter) to create a new document and add the pages.

Currently, the XlsDocumentOptions class contains no extra options.

Example

This example will create a new Windows Enhanced Meta File (EMF) file using the various supported options.

C#
VB
using Leadtools.Forms.DocumentWriters; 
using Leadtools; 
using Leadtools.Codecs; 
 
public void XlsDocumentOptionsExample() 
{ 
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf"); 
   var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Example.xls"); 
 
   // Setup a new RasterCodecs object 
   var codecs = new RasterCodecs(); 
   codecs.Options.RasterizeDocument.Load.Resolution = 300; 
 
   // Get the number of pages in the input document 
   var pageCount = codecs.GetTotalPages(inputFileName); 
 
   // Create a new instance of the LEADTOOLS Document Writer 
   var docWriter = new DocumentWriter(); 
 
   // Change the XLS options 
   var xlsOptions = docWriter.GetOptions(DocumentFormat.Xls) as XlsDocumentOptions; 
   // XLS currently does not have any extra options 
   // In the future, you can modify the options here if needed 
   docWriter.SetOptions(DocumentFormat.Xls, xlsOptions); 
 
   // Create a new XLS document 
   Console.WriteLine("Creating new XLS document: {0}", outputFileName); 
   docWriter.BeginDocument(outputFileName, DocumentFormat.Xls); 
 
   // Loop through all the pages 
   for (var pageNumber = 1; pageNumber <= pageCount; pageNumber++) 
   { 
      // Get the page as SVG 
      Console.WriteLine("Loading page {0}", pageNumber); 
      var page = new DocumentSvgPage(); 
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, null); 
 
      // Add the page 
      Console.WriteLine("Adding page {0}", pageNumber); 
      docWriter.AddPage(page); 
 
      page.SvgDocument.Dispose(); 
   } 
 
   // Finally finish writing the XLS file on disk 
   docWriter.EndDocument(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
} 
Imports Leadtools.Forms.DocumentWriters 
Imports Leadtools 
Imports Leadtools.Codecs 
 
Public Sub XlsDocumentOptionsExample() 
   Dim inputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf") 
   Dim outputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Example.xls") 
 
   ' Setup a new RasterCodecs object 
   Dim codecs As New RasterCodecs() 
   codecs.Options.RasterizeDocument.Load.Resolution = 300 
 
   ' Get the number of pages in the input document 
   Dim pageCount As Integer = codecs.GetTotalPages(inputFileName) 
 
   ' Create a new instance of the LEADTOOLS Document Writer 
   Dim docWriter As New DocumentWriter() 
 
   ' Change the XLS options 
   Dim xlsOptions As XlsDocumentOptions = DirectCast(docWriter.GetOptions(DocumentFormat.Xls), XlsDocumentOptions) 
   ' XLS currently does not have any extra options 
   ' In the future, you can modify the options here if needed 
   docWriter.SetOptions(DocumentFormat.Xls, xlsOptions) 
 
   ' Create a new XLS document 
   Console.WriteLine("Creating new XLS document: {0}", outputFileName) 
   docWriter.BeginDocument(outputFileName, DocumentFormat.Xls) 
 
   ' Loop through all the pages 
   For pageNumber As Integer = 1 To pageCount 
      ' Get the page as SVG 
      Console.WriteLine("Loading page {0}", pageNumber) 
      Dim page As New DocumentSvgPage() 
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, Nothing) 
 
      ' Add the page 
      Console.WriteLine("Adding page {0}", pageNumber) 
      docWriter.AddPage(page) 
 
      page.SvgDocument.Dispose() 
   Next 
 
   ' Finally finish writing the XLS file on disk 
   docWriter.EndDocument() 
   codecs.Dispose() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

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

Leadtools.Forms.DocumentWriters Assembly
Introduction
Getting Started
Namespaces
Leadtools.Forms.DocumentWriters Namespace
Assemblies