ExcelScript.HeaderFooterGroup interface
Methods
get |
The general header/footer, used for all pages unless even/odd or first page is specified. |
get |
The header/footer to use for even pages, odd header/footer needs to be specified for odd pages. |
get |
The first page header/footer, for all other pages general or even/odd is used. |
get |
The header/footer to use for odd pages, even header/footer needs to be specified for even pages. |
get |
The state by which headers/footers are set. See |
get |
Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet. |
get |
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. |
set |
The state by which headers/footers are set. See |
set |
Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet. |
set |
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
getEvenPages()
The header/footer to use for even pages, odd header/footer needs to be specified for odd pages.
getEvenPages(): HeaderFooter;
Returns
getFirstPage()
The first page header/footer, for all other pages general or even/odd is used.
getFirstPage(): HeaderFooter;
Returns
getOddPages()
The header/footer to use for odd pages, even header/footer needs to be specified for even pages.
getOddPages(): HeaderFooter;
Returns
getState()
The state by which headers/footers are set. See ExcelScript.HeaderFooterState
for details.
getState(): HeaderFooterState;
Returns
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
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
Office Scripts