SheetXL - v1.0.2
    Preparing search index...

    Interface IHeaderFooterGroup

    The headers and footers of a sheet: one set for every page, or separate ones for the first page and for even pages.

    Shaped after Office Scripts' HeaderFooterGroup. Excel keeps one set for odd pages, which is also the set used for every page when even pages have none of their own, so getDefaultForAllPages and getOddPages return the same headers and footers.

    interface IHeaderFooterGroup {
        getDefaultForAllPages(): IHeaderFooter;
        getEvenPages(): IHeaderFooter;
        getFirstPage(): IHeaderFooter;
        getOddPages(): IHeaderFooter;
        getState(): IPageLayout.HeaderFooterState;
        getUseSheetMargins(): boolean;
        getUseSheetScale(): boolean;
        setState(
            state: IPageLayout.HeaderFooterState,
            options?: ITransaction.OperationOptions,
        ): this;
        setUseSheetMargins(
            useSheetMargins: boolean,
            options?: ITransaction.OperationOptions,
        ): this;
        setUseSheetScale(
            useSheetScale: boolean,
            options?: ITransaction.OperationOptions,
        ): this;
    }
    Index
    getDefaultForAllPages getEvenPages getFirstPage getOddPages getState getUseSheetMargins getUseSheetScale setState setUseSheetMargins setUseSheetScale

    • The headers and footers used for every page the other sets do not cover.

      Returns IHeaderFooter

    • The headers and footers of even pages, used when the state includes odd and even pages.

      Returns IHeaderFooter

    • The headers and footers of the first page, used when the state includes the first page.

      Returns IHeaderFooter

    • Whether the headers and footers line up with the page's left and right margins.

      Returns boolean

      true

    • Whether the headers and footers scale with the sheet's print scale.

      Returns boolean

      true

    Settings
    Member Visibility

    On This Page
    Methods