Excel.Interfaces.PageLayoutData interface

Package:

excel

An interface describing the data returned by calling pageLayout.toJSON().

Properties

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

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?: number;

Property Value

number

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?: number | "";

Property Value

number | ""

Remarks

[ API set: ExcelApi 1.9 ]

footerMargin

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

footerMargin?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

headerMargin

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

headerMargin?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

headersFooters

Header and footer configuration for the worksheet.

headersFooters?: Excel.Interfaces.HeaderFooterGroupData;

Property Value

Excel.Interfaces.HeaderFooterGroupData

Remarks

[ API set: ExcelApi 1.9 ]

leftMargin

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

leftMargin?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

orientation

The worksheet's orientation of the page.

orientation?: Excel.PageOrientation | "Portrait" | "Landscape";

Property Value

Excel.PageOrientation | "Portrait" | "Landscape"

Remarks

[ API set: ExcelApi 1.9 ]

paperSize

The worksheet's paper size of the page.

paperSize?: Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman";

Property Value

Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman"

Remarks

[ API set: ExcelApi 1.9 ]

printComments

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

printComments?: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace";

Property Value

Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"

Remarks

[ API set: ExcelApi 1.9 ]

printErrors

The worksheet's print errors option.

printErrors?: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable";

Property Value

Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"

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?: Excel.PrintOrder | "DownThenOver" | "OverThenDown";

Property Value

Excel.PrintOrder | "DownThenOver" | "OverThenDown"

Remarks

[ API set: ExcelApi 1.9 ]

rightMargin

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

rightMargin?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

topMargin

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

topMargin?: number;

Property Value

number

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?: Excel.PageLayoutZoomOptions;

Property Value

Excel.PageLayoutZoomOptions

Remarks

[ API set: ExcelApi 1.9 ]