MultiPageEnableMargins Property

Summary

Gets or sets a value indicating whether to ignore the margins when rendering a sheet or a page.

Syntax

Objective-C

C++/CLI

Python

public bool MultiPageEnableMargins { get; set; }

@property (nonatomic, assign) BOOL multiPageEnableMargins;

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

MultiPageEnableMargins # get and set (CodecsExcelLoadOptions)

Property Value

Value	Description
true	To consider the margins when rendering a sheet or a page
false	To not consider the margins when rendering a sheet or a page. The 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

Margins are supported when loading XLSX files, not the legacy XLS files.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
 
using Leadtools.ImageProcessing.Core; 
using Leadtools.Pdf; 
 
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 
   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 codecsExcelOptionsExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   RasterCodecs codecs = new RasterCodecs(); 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "barcode1.tif"); 
 
   // 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 - CodecsExcelOptions & 
   // CodecsExcelLoadOptions reference 
   codecs.getOptions().getExcel().getLoad().setMultiPageSheet(false); 
   codecs.getOptions().getExcel().getLoad().setMultiPageEnableMargins(false); 
   codecs.getOptions().getExcel().getLoad().setMultiPageUseSheetWidth(false); 
   codecs.getOptions().getExcel().getLoad().setPageOrderDownThenOver(false); 
   codecs.getOptions().getExcel().getLoad().setShowHiddenSheets(false); // ShowHiddenSheet reference 
 
   // Load the source file 
   RasterImage image = codecs.load(srcFileName); 
 
   // Show the image information 
   System.out.printf("Image has %d pages%n", image.getPageCount()); 
   System.out.printf("Image size: %d by %2d pixels at %3d by %4d DPI", 
         image.getImageWidth(), image.getImageHeight(), image.getXResolution(), image.getYResolution()); 
 
   String outputFileName = combine(LEAD_VARS_IMAGES_DIR, "Result.jpg"); 
   codecs.save(image, outputFileName, RasterImageFormat.JPEG, 0); 
 
   assertTrue("File unsuccessfully saved to " + outputFileName, (new File(outputFileName)).exists()); 
   System.out.printf("File successfully saved to %s%n", outputFileName); 
 
   // To save as BMP, uncomment out this line: 
   // codecs.save(image, srcFileName + ".bmp", RasterImageFormat.BMP, 24); 
 
   // Clean up 
   image.dispose(); 
   codecs.dispose(); 
}

Requirements

Target Platforms