Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
XL.Sheet.GetPrintArea
Gets the print area.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
XL | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "XL.Sheet.GetPrintArea"; bookRef; sheetIndex; selector ) More
Parameters
Parameter | Description | Example |
---|---|---|
bookRef | The reference to the workbook. Please use XL.LoadBook to load a file. | $ref |
sheetIndex | The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1. | 0 |
selector | The value to query: rowFirst, rowLast, colFirst, colLast. | "rowFirst" |
Result
Returns value or error.
Description
Gets the print area.Returns error if print area isn't found.
Examples
Query first row of print area:
Set Variable [$printAreaRowFirst; Value: MBS( "XL.Sheet.GetPrintArea"; $book; $sheet; "RowFirst" ) ]
See also
- XL.Book.SheetCount
- XL.LoadBook
- XL.Sheet.ClearPrintArea
- XL.Sheet.GetPicture
- XL.Sheet.GetPrintFit
- XL.Sheet.GetPrintRow
- XL.Sheet.SetPrintArea
- XL.Sheet.SetPrintFit
- XL.Sheet.SetPrintRow
- XL.Sheet.SetPrintZoom
This function checks for a license.
Created 6th May 2015, last changed 9th November 2021