MultiPageEnableMargins Property

Summary

Considers the margins when rendering a sheet or a page.

Syntax

C++/CLI

Python

public bool MultiPageEnableMargins { get; set; }

public:  
   property bool MultiPageEnableMargins 
   { 
      bool get() 
      void set(bool value) 
   }

MultiPageEnableMargins # get and set (CodecsXlsLoadOptions)

Property Value

Value	Description
true	To enable considering the margins when rendering a sheet or a page.
false	To disable considering the margins when rendering a sheet or a page. Default value is false.

Remarks

When the value of MultiPageEnableMargins is true, the engine will use the margins set in CodecsRasterizeDocumentLoadOptions.LeftMargin, TopMargin, RightMargin and BottomMargin when rendering a sheet or page. These margins can be set using rasterCodecs.Options.RasterizeDocument.Load.

When the value of MultiPageEnableMargins is false, the margins are ignored.

Note that margins are supported when loading XLSX files, not the legacy XLS files.

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

CodecsXlsLoadOptions Class

CodecsXlsLoadOptions Members

Leadtools.Codecs Namespace

Download our FREE evaluation

Help Version 22.0.2023.5.5

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies