XlsDocumentOptions Class

C#
Visual Basic
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public class XlsDocumentOptions : DocumentOptions

'Declaration
 
Public Class XlsDocumentOptions 
   Inherits DocumentOptions

'Usage
 
Dim instance As XlsDocumentOptions

public sealed class XlsDocumentOptions : DocumentOptions

function Leadtools.Forms.DocumentWriters.XlsDocumentOptions()

public ref class XlsDocumentOptions : public DocumentOptions

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:

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.
Use the various XlsDocumentOptions properties to change the options.
Use DocumentWriter.SetOptions to set the new options in the engine.
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.

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools.Forms.DocumentWriters
Imports Leadtools
Imports Leadtools.Codecs

' Windows API functions needed to load/delete an EMF
<DllImport("gdi32.dll")> _
Private Shared Function GetEnhMetaFile(ByVal lpszMetaFile As String) As IntPtr
End Function
<DllImport("gdi32.dll")> _
Private Shared Function DeleteEnhMetaFile(ByVal hemf As IntPtr) As Boolean
End Function

Private Sub XlsDocumentOptionsExample()
   ' Unlock the support needed for LEADTOOLS Document Writers (with PDF output)
   RasterSupport.Unlock(RasterSupportType.DocumentWriters, "Replace with your own key here")

   ' Create a new instance of the LEADTOOLS Document Writer
   Dim docWriter As New DocumentWriter()

   Dim outputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Test.xls")
   Dim emfFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.emf")

   Dim xlsOptions As XlsDocumentOptions = DirectCast(docWriter.GetOptions(DocumentFormat.Xls), XlsDocumentOptions)

   docWriter.SetOptions(DocumentFormat.Xls, xlsOptions)

   ' Create a new XLS document
   Console.WriteLine("Creating new XLS document: {0}", outputFileName)
   docWriter.BeginDocument(outputFileName, DocumentFormat.Xls)

   ' Use the Windows API to load the EMF
   Dim emfHandle As IntPtr = GetEnhMetaFile(emfFileName)

   ' Add the page
   Dim page As DocumentPage = DocumentPage.Empty
   page.EmfHandle = emfHandle
   page.Image = Nothing

   Console.WriteLine("Adding EMF page from: {0}", emfFileName)
   docWriter.AddPage(page)

   ' Use the Windows API to delete the EMF
   DeleteEnhMetaFile(emfHandle)

   ' Finally finish writing the XLS file on disk
   docWriter.EndDocument()
End Sub

using Leadtools.Forms.DocumentWriters;
using Leadtools;

// Windows API functions needed to load/delete an EMF
[DllImport("gdi32.dll")]
private static extern IntPtr GetEnhMetaFile(string lpszMetaFile);
[DllImport("gdi32.dll")]
private static extern bool DeleteEnhMetaFile(IntPtr hemf);
private void XlsDocumentOptionsExample()
{
   // Create a new instance of the LEADTOOLS Document Writer
   DocumentWriter docWriter = new DocumentWriter();

   string outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Test.xls");
   string emfFileName = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.emf");

   XlsDocumentOptions xlsOptions = docWriter.GetOptions(DocumentFormat.Xls) as XlsDocumentOptions;

   // Use default resolution
   docWriter.SetOptions(DocumentFormat.Xls, xlsOptions);

   // Create a new XLS document
   Console.WriteLine("Creating new XLS document: {0}", outputFileName);
   docWriter.BeginDocument(outputFileName, DocumentFormat.Xls);

   // Use the Windows API to load the EMF
   IntPtr emfHandle = GetEnhMetaFile(emfFileName);

   // Add the page
   DocumentPage page = DocumentPage.Empty;
   page.EmfHandle = emfHandle;
   page.Image = null;

   Console.WriteLine("Adding EMF page from: {0}", emfFileName);
   docWriter.AddPage(page);

   // Use the Windows API to delete the EMF
   DeleteEnhMetaFile(emfHandle);

   // Finally finish writing the XLS file on disk
   docWriter.EndDocument();
}

Target Platforms

Reference

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