Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
CodecsXlsLoadOptions Class
See Also  Members   Example 
Leadtools.Codecs Namespace : CodecsXlsLoadOptions Class



Provides the options for loading Microsoft Excel 2003 (XLS) documents as a raster image.

Syntax

Visual Basic (Declaration) 
Public Class CodecsXlsLoadOptions
Visual Basic (Usage)Copy Code
Dim instance As CodecsXlsLoadOptions
C# 
public class CodecsXlsLoadOptions
C++/CLI 
public ref class CodecsXlsLoadOptions

Example

This example will load the given Excel 2003 file and render it as a raster image

Visual BasicCopy Code
Public Sub CodecsXlsOptionsExample()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()

   Dim srcFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.Xls"

   ' Enable using the RasterizeDocumentOptions
   Dim rasterizeDocumentLoadOptions As CodecsRasterizeDocumentLoadOptions = codecs.Options.RasterizeDocument.Load
   rasterizeDocumentLoadOptions.Enabled = True
   ' Fit the document at 8.5 by 11 inches at 96 DPI keeping the aspect ratio
   rasterizeDocumentLoadOptions.SizeMode = CodecsRasterizeDocumentSizeMode.Fit
   rasterizeDocumentLoadOptions.PageWidth = 8.5
   rasterizeDocumentLoadOptions.PageHeight = 11
   rasterizeDocumentLoadOptions.Unit = CodecsRasterizeDocumentUnit.Inch
   rasterizeDocumentLoadOptions.XResolution = 300
   rasterizeDocumentLoadOptions.YResolution = 300

   ' Load each sheet in a separate page
   codecs.Options.Xls.Load.MultiPageSheet = False

   ' Load the source file
   Using image As RasterImage = codecs.Load(srcFileName)
      ' Show the image information
      Console.WriteLine("Image has {0} pages", image.PageCount)
      Console.WriteLine("Image size: {0} by {1} pixels at {2} by {3} DPI", _
         image.ImageWidth, image.ImageHeight, image.XResolution, image.YResolution)
   End Using

   ' Clean up
   codecs.Dispose()
   RasterCodecs.Shutdown()
End Sub
C#Copy Code
public void CodecsXlsOptionsExample() 
{ 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.Xls"; 
 
   // Enable using the RasterizeDocumentOptions 
   CodecsRasterizeDocumentLoadOptions rasterizeDocumentLoadOptions = codecs.Options.RasterizeDocument.Load; 
   rasterizeDocumentLoadOptions.Enabled = true; 
   // Fit the document at 8.5 by 11 inches at 96 DPI keeping the aspect ratio 
   rasterizeDocumentLoadOptions.SizeMode = CodecsRasterizeDocumentSizeMode.Fit; 
   rasterizeDocumentLoadOptions.PageWidth = 8.5; 
   rasterizeDocumentLoadOptions.PageHeight = 11; 
   rasterizeDocumentLoadOptions.Unit = CodecsRasterizeDocumentUnit.Inch; 
   rasterizeDocumentLoadOptions.XResolution = 300; 
   rasterizeDocumentLoadOptions.YResolution = 300; 
 
   // Load each sheet in a separate page 
   codecs.Options.Xls.Load.MultiPageSheet = false; 
 
   // Load the source file 
   using(RasterImage image = codecs.Load(srcFileName)) 
   { 
      // Show the image information 
      Console.WriteLine("Image has {0} pages", image.PageCount); 
      Console.WriteLine("Image size: {0} by {1} pixels at {2} by {3} DPI", 
         image.ImageWidth, image.ImageHeight, image.XResolution, image.YResolution); 
   } 
 
   // Clean up 
   codecs.Dispose(); 
   RasterCodecs.Shutdown(); 
}

Remarks

Microsoft Excel 2003 (XLS) files have no physical width or height in pixels. You can use the CodecsRasterizeDocumentOptions to control how the final document is rendered as a raster image. For more information, refer to CodecsRasterizeDocumentLoadOptions.

For more information, refer to File Formats - XLS Format.

Important note: The XLS file format only supports the following rasterization size modes:

All other size modes will be treated as CodecsRasterizeDocumentSizeMode.Fit

XLS also does not support loading a document using different horizontal or vertical resolution. So if the value of CodecsRasterizeDocumentLoadOptions.XResolution and CodecsRasterizeDocumentLoadOptions.YResolution are different, the XLS codecs will use the larger of the two values as the resolution to use when rasterization.

Inheritance Hierarchy

System.Object
   Leadtools.Codecs.CodecsXlsLoadOptions

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also