Excel.Interfaces.PageLayoutLoadOptions interface
Represents layout and print settings that are not dependent on any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area.
Remarks
Properties
$all | Specifying |
black |
The worksheet's black and white print option. |
bottom |
The worksheet's bottom page margin to use for printing in points. |
center |
The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally when it's printed. |
center |
The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically when it's printed. |
draft |
The worksheet's draft mode option. If |
first |
The worksheet's first page number to print. A |
footer |
The worksheet's footer margin, in points, for use when printing. |
header |
The worksheet's header margin, in points, for use when printing. |
headers |
Header and footer configuration for the worksheet. |
left |
The worksheet's left margin, in points, for use when printing. |
orientation | The worksheet's orientation of the page. |
paper |
The worksheet's paper size of the page. |
print |
Specifies if the worksheet's comments should be displayed when printing. |
print |
The worksheet's print errors option. |
print |
Specifies if the worksheet's gridlines will be printed. |
print |
Specifies if the worksheet's headings will be printed. |
print |
The worksheet's page print order option. This specifies the order to use for processing the page number printed. |
right |
The worksheet's right margin, in points, for use when printing. |
top |
The worksheet's top margin, in points, for use when printing. |
zoom | The worksheet's print zoom options. The |
Property Details
$all
Specifying $all
for the load options loads all the scalar properties (such as Range.address
) but not the navigational properties (such as Range.format.fill.color
).
$all?: boolean;
Property Value
boolean
blackAndWhite
The worksheet's black and white print option.
blackAndWhite?: boolean;
Property Value
boolean
Remarks
bottomMargin
The worksheet's bottom page margin to use for printing in points.
bottomMargin?: boolean;
Property Value
boolean
Remarks
centerHorizontally
The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally when it's printed.
centerHorizontally?: boolean;
Property Value
boolean
Remarks
centerVertically
The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically when it's printed.
centerVertically?: boolean;
Property Value
boolean
Remarks
draftMode
The worksheet's draft mode option. If true
, the sheet will be printed without graphics.
draftMode?: boolean;
Property Value
boolean
Remarks
firstPageNumber
The worksheet's first page number to print. A null
value represents "auto" page numbering.
firstPageNumber?: boolean;
Property Value
boolean
Remarks
footerMargin
The worksheet's footer margin, in points, for use when printing.
footerMargin?: boolean;
Property Value
boolean
Remarks
headerMargin
The worksheet's header margin, in points, for use when printing.
headerMargin?: boolean;
Property Value
boolean
Remarks
headersFooters
Header and footer configuration for the worksheet.
headersFooters?: Excel.Interfaces.HeaderFooterGroupLoadOptions;
Property Value
Remarks
leftMargin
The worksheet's left margin, in points, for use when printing.
leftMargin?: boolean;
Property Value
boolean
Remarks
orientation
The worksheet's orientation of the page.
orientation?: boolean;
Property Value
boolean
Remarks
paperSize
The worksheet's paper size of the page.
paperSize?: boolean;
Property Value
boolean
Remarks
printComments
Specifies if the worksheet's comments should be displayed when printing.
printComments?: boolean;
Property Value
boolean
Remarks
printErrors
The worksheet's print errors option.
printErrors?: boolean;
Property Value
boolean
Remarks
printGridlines
Specifies if the worksheet's gridlines will be printed.
printGridlines?: boolean;
Property Value
boolean
Remarks
printHeadings
Specifies if the worksheet's headings will be printed.
printHeadings?: boolean;
Property Value
boolean
Remarks
printOrder
The worksheet's page print order option. This specifies the order to use for processing the page number printed.
printOrder?: boolean;
Property Value
boolean
Remarks
rightMargin
The worksheet's right margin, in points, for use when printing.
rightMargin?: boolean;
Property Value
boolean
Remarks
topMargin
The worksheet's top margin, in points, for use when printing.
topMargin?: boolean;
Property Value
boolean
Remarks
zoom
The worksheet's print zoom options. The PageLayoutZoomOptions
object must be set as a JSON object (use x.zoom = {...}
instead of x.zoom.scale = ...
).
zoom?: boolean;
Property Value
boolean
Remarks
Office Add-ins