←Select platform

CodecsExcelLoadOptions Class


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


public class CodecsExcelLoadOptions  
@interface LTCodecsExcelLoadOptions : NSObject 
public class CodecsExcelLoadOptions 
public ref class CodecsExcelLoadOptions  
class CodecsExcelLoadOptions: 


Microsoft Excel (XLSX) and Excel 97-2003 (XLS) files have no physical width or height in pixels. 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/XLSX Format.

Important note

The XLS and XLSX file formats support only the following rasterization size modes:

All other size modes will be treated as CodecsRasterizeDocumentSizeMode.Fit.

The XLS/XLSX file formats do not support loading a document using different horizontal or vertical resolutions. So if the value of CodecsRasterizeDocumentLoadOptions.XResolution and CodecsRasterizeDocumentLoadOptions.YResolution are different, the XLS/XLSX codecs will use the larger of the two values as the resolution when rasterizing.


The example below will load the given Microsoft Excel file (XLSX) and render it as a raster image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Core; 
public void CodecsExcelOptionsExample() 
   RasterCodecs codecs = new RasterCodecs(); 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "test.Xls"); 
   // Enable using the RasterizeDocumentOptions 
   CodecsRasterizeDocumentLoadOptions rasterizeDocumentLoadOptions = codecs.Options.RasterizeDocument.Load; 
   // 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 - CodecsExcelOptions & CodecsExcelLoadOptions reference 
   codecs.Options.Excel.Load.MultiPageSheet = false; 
   codecs.Options.Excel.Load.MultiPageEnableMargins = false; 
   codecs.Options.Excel.Load.MultiPageUseSheetWidth = false; 
   codecs.Options.Excel.Load.PageOrderDownThenOver = false; 
   codecs.Options.Excel.Load.ShowHiddenSheets = false; // ShowHiddenSheet reference 
   // Load the source file 
   using (RasterImage image = codecs.Load(srcFileName)) 
      // Show the image information 
      Debug.WriteLine("Image has {0} pages", image.PageCount); 
      Debug.WriteLine("Image size: {0} by {1} pixels at {2} by {3} DPI", 
         image.ImageWidth, image.ImageHeight, image.XResolution, image.YResolution); 
      //To save as BMP, uncomment out this line: 
      //codecs.Save(image, srcFileName + ".bmp", RasterImageFormat.Bmp, 24); 
   // Clean up 
static class LEAD_VARS 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 


Target Platforms

See Also

CodecsExcelLoadOptions Members

Leadtools.Codecs Namespace

Help Version 22.0.2023.5.5
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Codecs Assembly

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.