Load Property

Summary

Gets the object to set the options for loading Microsoft Excel (XLSX) and Excel 97-2003 (XLS) documents as raster images.

Syntax

C++/CLI

Java

Python

public CodecsXlsLoadOptions Load { get; }

public CodecsXlsLoadOptions getLoad()

public: 
property CodecsXlsLoadOptions^ Load { 
   CodecsXlsLoadOptions^ get(); 
}

Load # get  (CodecsXlsOptions)

Property Value

The XLS/XLSX options used to load Microsoft Excel (XLSX) and Excel 97-2003 (XLS) documents as a raster image.

Example

using Leadtools; 
using Leadtools.Codecs; 
 
using Leadtools.ImageProcessing.Core; 
 
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:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms

Reference

CodecsXlsOptions Class

CodecsXlsOptions Members

Download our FREE evaluation

Help Version 22.0.2023.5.5

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies