CodecsXlsLoadOptions Class

Summary

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

Syntax

C++/CLI

Java

Python

public class CodecsXlsLoadOptions

public class CodecsXlsLoadOptions

public ref class CodecsXlsLoadOptions

class CodecsXlsLoadOptions:

Remarks

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 to use when rasterizing.

Example

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

Java

using Leadtools; 
using Leadtools.Codecs; 
 
using Leadtools.ImageProcessing.Core; 
using Leadtools.Pdf; 
 
public void CodecsXlsOptionsExample() 
{ 
   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 
   // CodecsXlsOptions & CodecsXlsLoadOptions reference 
   codecs.Options.Xls.Load.MultiPageSheet = true; 
   codecs.Options.Xls.Load.MultiPageEnableMargins = false; 
   codecs.Options.Xls.Load.MultiPageUseSheetWidth = false; 
   codecs.Options.Xls.Load.PageOrderDownThenOver = false; 
   codecs.Options.Xls.Load.ShowHiddenSheet = false; 
 
   // 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); 
   } 
 
   // Clean up 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
import java.net.URI; 
import java.net.URISyntaxException; 
import java.nio.file.Paths; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.imageprocessing.core.MinMaxBitsCommand; 
 
 
public void codecsXlsOptionsExample(){ 
   RasterCodecs codecs = new RasterCodecs(); 
   String LEAD_VARS_IMAGES_DIR ="C:\\LEADTOOLS23\\Resources\\Images"; 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "large_sheet_5k.xls"); 
 
   // Enable using the RasterizeDocumentOptions 
   CodecsRasterizeDocumentLoadOptions rasterizeDocumentLoadOptions = 
   codecs.getOptions().getRasterizeDocument().getLoad(); 
 
   // Fit the document at 8.5 by 11 inches at 96 DPI keeping the aspect ratio 
   rasterizeDocumentLoadOptions.setSizeMode(CodecsRasterizeDocumentSizeMode.FIT); 
   rasterizeDocumentLoadOptions.setPageWidth(8.5); 
   rasterizeDocumentLoadOptions.setPageHeight(11); 
   rasterizeDocumentLoadOptions.setUnit(CodecsRasterizeDocumentUnit.INCH); 
   rasterizeDocumentLoadOptions.setXResolution(300); 
   rasterizeDocumentLoadOptions.setYResolution(300); 
 
   // Load each sheet in a separate page 
   codecs.getOptions().getExcel().getLoad().setMultiPageSheet(true); 
   codecs.getOptions().getExcel().getLoad().setMultiPageEnableMargins(false); 
   codecs.getOptions().getExcel().getLoad().setMultiPageUseSheetWidth(false); 
   codecs.getOptions().getExcel().getLoad().setPageOrderDownThenOver(false); 
   codecs.getOptions().getExcel().getLoad().setShowHiddenSheets(false); 
 
   // Load the source file 
   RasterImage image = codecs.load(srcFileName); 
 
   // Show the image information 
   System.out.println("Image has " + image.getPageCount() + " pages"); 
   System.out.printf("Image size: %1d by %2d pixels at %3d by %4d DPI%n", 
   image.getImageWidth(), image.getImageHeight(), image.getXResolution(), 
   image.getYResolution()); 
   image = null; 
 
   // Clean up 
   codecs.dispose(); 
}

Requirements

Target Platforms

Reference

CodecsXlsLoadOptions Members

Leadtools.Codecs Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies