The XlsDocumentOptions Class is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.
Provides extra options to use when saving a document using the Microsoft Excel 2003 format (XLS).![](dotnetdiagramimages/Leadtools_Forms_DocumentWriters_Leadtools_Forms_DocumentWriters_XlsDocumentOptions.png)
Visual Basic (Declaration) | |
---|---|
Public Class XlsDocumentOptions Inherits DocumentOptions |
Visual Basic (Usage) | ![]() |
---|---|
Dim instance As XlsDocumentOptions |
C# | |
---|---|
public class XlsDocumentOptions : DocumentOptions |
C++/CLI | |
---|---|
public ref class XlsDocumentOptions : public DocumentOptions |
This example will create a new Windows Enhanced Meta File (EMF) file using the various supported options.
Visual Basic | ![]() |
---|---|
' 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 Public NotInheritable Class LEAD_VARS Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" End Class |
C# | ![]() |
---|---|
// 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() { // 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 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(); } static class LEAD_VARS { public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; } |
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.
System.Object
Leadtools.Forms.DocumentWriters.DocumentOptions
Leadtools.Forms.DocumentWriters.XlsDocumentOptions
Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7