SheetXL - v1.0.2
    Preparing search index...

    Interface IHeaderFooter

    One set of a header and a footer, each with a left, center and right section.

    Shaped after Office Scripts' HeaderFooter. Text uses Excel's codes: &P page number, &N page count, &D date, &T time, &F file name, &A sheet name, &Z file path, &G a picture, &B bold, &I italic, &U underline, &"Font,Style", &12 size, &KFF0000 color, and && for an ampersand.

    A header or footer is kept as one string, as Excel stores it, with &L, &C and &R marking where each section starts; getHeader returns it whole. Text before any section mark is the center section, and a section marked twice reads as its parts joined, which is how Excel reads them. A string is kept exactly as read until a section of it is set, when it is rebuilt in Excel's order: left, center, right.

    interface IHeaderFooter {
        getCenterFooter(): string;
        getCenterHeader(): string;
        getFooter(): string;
        getHeader(): string;
        getLeftFooter(): string;
        getLeftHeader(): string;
        getRightFooter(): string;
        getRightHeader(): string;
        setCenterFooter(
            centerFooter: string,
            options?: ITransaction.OperationOptions,
        ): this;
        setCenterHeader(
            centerHeader: string,
            options?: ITransaction.OperationOptions,
        ): this;
        setFooter(footer: string, options?: ITransaction.OperationOptions): this;
        setHeader(header: string, options?: ITransaction.OperationOptions): this;
        setLeftFooter(
            leftFooter: string,
            options?: ITransaction.OperationOptions,
        ): this;
        setLeftHeader(
            leftHeader: string,
            options?: ITransaction.OperationOptions,
        ): this;
        setRightFooter(
            rightFooter: string,
            options?: ITransaction.OperationOptions,
        ): this;
        setRightHeader(
            rightHeader: string,
            options?: ITransaction.OperationOptions,
        ): this;
    }
    Index
    getCenterFooter getCenterHeader getFooter getHeader getLeftFooter getLeftHeader getRightFooter getRightHeader setCenterFooter setCenterHeader setFooter setHeader setLeftFooter setLeftHeader setRightFooter setRightHeader

    • The center section of the footer.

      Returns string

    • The center section of the header.

      Returns string

    • The whole footer.

      Returns string

      getHeader

    • The whole header, sections and codes included (&LPage &P&RDraft); "" when there is none.

      Returns string

      Office Scripts has no counterpart; it is the string Excel stores and openpyxl reads.

    • The left section of the footer.

      Returns string

    • The left section of the header.

      Returns string

    • The right section of the footer.

      Returns string

    • The right section of the header.

      Returns string

    Settings
    Member Visibility

    On This Page
    Methods