Excel.Interfaces.PageLayoutData interface

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

Properties

blackAndWhite

Gets or sets the worksheet's black and white print option.

[ API set: ExcelApi 1.9 ]

bottomMargin

Gets or sets the worksheet's bottom page margin to use for printing in points.

[ API set: ExcelApi 1.9 ]

centerHorizontally

Gets or sets the worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally when it's printed.

[ API set: ExcelApi 1.9 ]

centerVertically

Gets or sets the worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically when it's printed.

[ API set: ExcelApi 1.9 ]

draftMode

Gets or sets the worksheet's draft mode option. If true the sheet will be printed without graphics.

[ API set: ExcelApi 1.9 ]

firstPageNumber

Gets or sets the worksheet's first page number to print. Null value represents "auto" page numbering.

[ API set: ExcelApi 1.9 ]

footerMargin

Gets or sets the worksheet's footer margin, in points, for use when printing.

[ API set: ExcelApi 1.9 ]

headerMargin

Gets or sets the worksheet's header margin, in points, for use when printing.

[ API set: ExcelApi 1.9 ]

headersFooters

Header and footer configuration for the worksheet.

[ API set: ExcelApi 1.9 ]

leftMargin

Gets or sets the worksheet's left margin, in points, for use when printing.

[ API set: ExcelApi 1.9 ]

orientation

Gets or sets the worksheet's orientation of the page.

[ API set: ExcelApi 1.9 ]

paperSize

Gets or sets the worksheet's paper size of the page.

[ API set: ExcelApi 1.9 ]

printComments

Gets or sets whether the worksheet's comments should be displayed when printing.

[ API set: ExcelApi 1.9 ]

printErrors

Gets or sets the worksheet's print errors option.

[ API set: ExcelApi 1.9 ]

printGridlines

Gets or sets the worksheet's print gridlines flag. This flag determines whether gridlines will be printed or not.

[ API set: ExcelApi 1.9 ]

printHeadings

Gets or sets the worksheet's print headings flag. This flag determines whether headings will be printed or not.

[ API set: ExcelApi 1.9 ]

printOrder

Gets or sets the worksheet's page print order option. This specifies the order to use for processing the page number printed.

[ API set: ExcelApi 1.9 ]

rightMargin

Gets or sets the worksheet's right margin, in points, for use when printing.

[ API set: ExcelApi 1.9 ]

topMargin

Gets or sets the worksheet's top margin, in points, for use when printing.

[ API set: ExcelApi 1.9 ]

zoom

Gets or sets the worksheet's print zoom options.

[ API set: ExcelApi 1.9 ]

Property Details

blackAndWhite

Gets or sets the worksheet's black and white print option.

[ API set: ExcelApi 1.9 ]

blackAndWhite?: boolean;

Property Value

boolean

bottomMargin

Gets or sets the worksheet's bottom page margin to use for printing in points.

[ API set: ExcelApi 1.9 ]

bottomMargin?: number;

Property Value

number

centerHorizontally

Gets or sets the worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally when it's printed.

[ API set: ExcelApi 1.9 ]

centerHorizontally?: boolean;

Property Value

boolean

centerVertically

Gets or sets the worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically when it's printed.

[ API set: ExcelApi 1.9 ]

centerVertically?: boolean;

Property Value

boolean

draftMode

Gets or sets the worksheet's draft mode option. If true the sheet will be printed without graphics.

[ API set: ExcelApi 1.9 ]

draftMode?: boolean;

Property Value

boolean

firstPageNumber

Gets or sets the worksheet's first page number to print. Null value represents "auto" page numbering.

[ API set: ExcelApi 1.9 ]

firstPageNumber?: number | "";

Property Value

number | ""

footerMargin

Gets or sets the worksheet's footer margin, in points, for use when printing.

[ API set: ExcelApi 1.9 ]

footerMargin?: number;

Property Value

number

headerMargin

Gets or sets the worksheet's header margin, in points, for use when printing.

[ API set: ExcelApi 1.9 ]

headerMargin?: number;

Property Value

number

headersFooters

Header and footer configuration for the worksheet.

[ API set: ExcelApi 1.9 ]

headersFooters?: Excel.Interfaces.HeaderFooterGroupData;

Property Value

leftMargin

Gets or sets the worksheet's left margin, in points, for use when printing.

[ API set: ExcelApi 1.9 ]

leftMargin?: number;

Property Value

number

orientation

Gets or sets the worksheet's orientation of the page.

[ API set: ExcelApi 1.9 ]

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

Property Value

Excel.PageOrientation | "Portrait" | "Landscape"

paperSize

Gets or sets the worksheet's paper size of the page.

[ API set: ExcelApi 1.9 ]

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"

printComments

Gets or sets whether the worksheet's comments should be displayed when printing.

[ API set: ExcelApi 1.9 ]

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

Property Value

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

printErrors

Gets or sets the worksheet's print errors option.

[ API set: ExcelApi 1.9 ]

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

Property Value

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

printGridlines

Gets or sets the worksheet's print gridlines flag. This flag determines whether gridlines will be printed or not.

[ API set: ExcelApi 1.9 ]

printGridlines?: boolean;

Property Value

boolean

printHeadings

Gets or sets the worksheet's print headings flag. This flag determines whether headings will be printed or not.

[ API set: ExcelApi 1.9 ]

printHeadings?: boolean;

Property Value

boolean

printOrder

Gets or sets the worksheet's page print order option. This specifies the order to use for processing the page number printed.

[ API set: ExcelApi 1.9 ]

printOrder?: Excel.PrintOrder | "DownThenOver" | "OverThenDown";

Property Value

Excel.PrintOrder | "DownThenOver" | "OverThenDown"

rightMargin

Gets or sets the worksheet's right margin, in points, for use when printing.

[ API set: ExcelApi 1.9 ]

rightMargin?: number;

Property Value

number

topMargin

Gets or sets the worksheet's top margin, in points, for use when printing.

[ API set: ExcelApi 1.9 ]

topMargin?: number;

Property Value

number

zoom

Gets or sets the worksheet's print zoom options.

[ API set: ExcelApi 1.9 ]

zoom?: Excel.PageLayoutZoomOptions;

Property Value