Edit

Share via

Excel.Interfaces.PageLayoutLoadOptions interface

Package:
excel

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

[ API set: ExcelApi 1.9 ]

Properties

$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).
blackAndWhite

The worksheet's black and white print option.
bottomMargin

The worksheet's bottom page margin to use for printing in points.
centerHorizontally

The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally when it's printed.
centerVertically

The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically when it's printed.
draftMode

The worksheet's draft mode option. If true, the sheet will be printed without graphics.
firstPageNumber

The worksheet's first page number to print. A null value represents "auto" page numbering.
footerMargin

The worksheet's footer margin, in points, for use when printing.
headerMargin

The worksheet's header margin, in points, for use when printing.
headersFooters

Header and footer configuration for the worksheet.
leftMargin

The worksheet's left margin, in points, for use when printing.
orientation

The worksheet's orientation of the page.
paperSize

The worksheet's paper size of the page.
printComments

Specifies if the worksheet's comments should be displayed when printing.
printErrors

The worksheet's print errors option.
printGridlines

Specifies if the worksheet's gridlines will be printed.
printHeadings

Specifies if the worksheet's headings will be printed.
printOrder

The worksheet's page print order option. This specifies the order to use for processing the page number printed.
rightMargin

The worksheet's right margin, in points, for use when printing.
topMargin

The worksheet's top margin, in points, for use when printing.
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 = ...).

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

[ API set: ExcelApi 1.9 ]

bottomMargin

The worksheet's bottom page margin to use for printing in points.

bottomMargin?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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

[ API set: ExcelApi 1.9 ]

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

[ API set: ExcelApi 1.9 ]

draftMode

The worksheet's draft mode option. If true, the sheet will be printed without graphics.

draftMode?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

firstPageNumber

The worksheet's first page number to print. A null value represents "auto" page numbering.

firstPageNumber?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

footerMargin

The worksheet's footer margin, in points, for use when printing.

footerMargin?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

headerMargin

The worksheet's header margin, in points, for use when printing.

headerMargin?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

headersFooters

Header and footer configuration for the worksheet.

headersFooters?: Excel.Interfaces.HeaderFooterGroupLoadOptions;

Property Value

Excel.Interfaces.HeaderFooterGroupLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

leftMargin

The worksheet's left margin, in points, for use when printing.

leftMargin?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

orientation

The worksheet's orientation of the page.

orientation?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

paperSize

The worksheet's paper size of the page.

paperSize?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

printComments

Specifies if the worksheet's comments should be displayed when printing.

printComments?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

printErrors

The worksheet's print errors option.

printErrors?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

printGridlines

Specifies if the worksheet's gridlines will be printed.

printGridlines?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

printHeadings

Specifies if the worksheet's headings will be printed.

printHeadings?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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

[ API set: ExcelApi 1.9 ]

rightMargin

The worksheet's right margin, in points, for use when printing.

rightMargin?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

topMargin

The worksheet's top margin, in points, for use when printing.

topMargin?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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

[ API set: ExcelApi 1.9 ]