ExcelScript.HeaderFooterGroup interface

Package:

ExcelScript

Methods

getDefaultForAllPages()	The general header/footer, used for all pages unless even/odd or first page is specified.
getEvenPages()	The header/footer to use for even pages, odd header/footer needs to be specified for odd pages.
getFirstPage()	The first page header/footer, for all other pages general or even/odd is used.
getOddPages()	The header/footer to use for odd pages, even header/footer needs to be specified for even pages.
getState()	The state by which headers/footers are set. See ExcelScript.HeaderFooterState for details.
getUseSheetMargins()	Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
getUseSheetScale()	Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.
setState(state)	The state by which headers/footers are set. See ExcelScript.HeaderFooterState for details.
setUseSheetMargins(useSheetMargins)	Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
setUseSheetScale(useSheetScale)	Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.

Method Details

getDefaultForAllPages()

The general header/footer, used for all pages unless even/odd or first page is specified.

getDefaultForAllPages(): HeaderFooter;

Returns

ExcelScript.HeaderFooter

getEvenPages()

The header/footer to use for even pages, odd header/footer needs to be specified for odd pages.

getEvenPages(): HeaderFooter;

Returns

ExcelScript.HeaderFooter

getFirstPage()

The first page header/footer, for all other pages general or even/odd is used.

getFirstPage(): HeaderFooter;

Returns

ExcelScript.HeaderFooter

getOddPages()

The header/footer to use for odd pages, even header/footer needs to be specified for even pages.

getOddPages(): HeaderFooter;

Returns

ExcelScript.HeaderFooter

getState()

The state by which headers/footers are set. See ExcelScript.HeaderFooterState for details.

getState(): HeaderFooterState;

Returns

ExcelScript.HeaderFooterState

getUseSheetMargins()

Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.

getUseSheetMargins(): boolean;

Returns

boolean

getUseSheetScale()

Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.

getUseSheetScale(): boolean;

Returns

boolean

setState(state)

The state by which headers/footers are set. See ExcelScript.HeaderFooterState for details.

setState(state: HeaderFooterState): void;

Parameters

state

ExcelScript.HeaderFooterState

Returns

void

setUseSheetMargins(useSheetMargins)

Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.

setUseSheetMargins(useSheetMargins: boolean): void;

Parameters

useSheetMargins

boolean

Returns

void

setUseSheetScale(useSheetScale)

Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.

setUseSheetScale(useSheetScale: boolean): void;

Parameters

useSheetScale

boolean

Returns

void