CodecsXlsOptions Class (original) (raw)
Summary
Provides the options for loading or saving Microsoft Excel (XLSX) and Excel 97-2003 (XLS) documents.
Syntax
public class CodecsXlsOptions
public class CodecsXlsOptions
public ref class CodecsXlsOptions
Remarks
This class is now deprecated. You should use the CodecsExcelOptions class instead.
Microsoft Excel (XLSX) and Excel 97-2003 (XLS) documents have no physical width or height in pixels. Use the CodecsRasterizeDocumentOptions to control how render the final object as a raster image. For more information, refer to CodecsRasterizeDocumentLoadOptions.
Currently, LEADTOOLS does not support saving raster images as XLSS/XLS documents.
For more information, refer to File Formats - XLS/XLSX Format.
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
See Also
Leadtools.Codecs Assembly
CompactFile(Stream,Stream,int,int,bool,int,int,bool,int,CodecsSavePageMode,bool,bool) Method
CompactFile(Stream,Stream,int,int,bool,long,int,bool,long,CodecsSavePageMode,bool,bool,bool) Method
CompactFile(string,string,int,int,bool,int,int,bool,int,CodecsSavePageMode,bool,bool) Method
CompactFile(string,string,int,int,bool,long,int,bool,long,CodecsSavePageMode,bool,bool,bool) Method