R: Set document headers and footers

setHeaderFooter {openxlsx} | R Documentation

## Set document headers and footers

### Description

Set document headers and footers

### Usage

    setHeaderFooter(wb, sheet, header = NULL, footer = NULL,
      evenHeader = NULL, evenFooter = NULL, firstHeader = NULL,
      firstFooter = NULL)

### Arguments

`wb` | A workbook object
`sheet` | A name or index of a worksheet
`header` | document header. Character vector of length 3 corresponding to positons left, center, right. Use NA to skip a positon.
`footer` | document footer. Character vector of length 3 corresponding to positons left, center, right. Use NA to skip a positon.
`evenHeader` | document header for even pages.
`evenFooter` | document footer for even pages.
`firstHeader` | document header for first page only.
`firstFooter` | document footer for first page only.

### Details

Headers and footers can contain special tags

- &[Page] Page number

- &[Pages] Number of pages

- &[Date] Current date

- &[Time] Current time

- &[Path] File path

- &[File] File name

- &[Tab] Worksheet name

### Author(s)

Alexander Walker

### See Also

`addWorksheet` to set headers and footers when adding a worksheet

### Examples

    wb <- createWorkbook()

    addWorksheet(wb, "S1")
    addWorksheet(wb, "S2")
    addWorksheet(wb, "S3")
    addWorksheet(wb, "S4")

    writeData(wb, 1, 1:400)
    writeData(wb, 2, 1:400)
    writeData(wb, 3, 3:400)
    writeData(wb, 4, 3:400)

    setHeaderFooter(wb, sheet = "S1",
                    header = c("ODD HEAD LEFT", "ODD HEAD CENTER", "ODD HEAD RIGHT"),
                    footer = c("ODD FOOT RIGHT", "ODD FOOT CENTER", "ODD FOOT RIGHT"),
                    evenHeader = c("EVEN HEAD LEFT", "EVEN HEAD CENTER", "EVEN HEAD RIGHT"),
                    evenFooter = c("EVEN FOOT RIGHT", "EVEN FOOT CENTER", "EVEN FOOT RIGHT"),
                    firstHeader = c("TOP", "OF FIRST", "PAGE"),
                    firstFooter = c("BOTTOM", "OF FIRST", "PAGE"))

    setHeaderFooter(wb, sheet = 2,
                    header = c("&[Date]", "ALL HEAD CENTER 2", "&[Page] / &[Pages]"),
                    footer = c("&[Path]&[File]", NA, "&[Tab]"),
                    firstHeader = c(NA, "Center Header of First Page", NA),
                    firstFooter = c(NA, "Center Footer of First Page", NA))

    setHeaderFooter(wb, sheet = 3,
                    header = c("ALL HEAD LEFT 2", "ALL HEAD CENTER 2", "ALL HEAD RIGHT 2"),
                    footer = c("ALL FOOT RIGHT 2", "ALL FOOT CENTER 2", "ALL FOOT RIGHT 2"))

    setHeaderFooter(wb, sheet = 4,
                    firstHeader = c("FIRST ONLY L", NA, "FIRST ONLY R"),
                    firstFooter = c("FIRST ONLY L", NA, "FIRST ONLY R"))

    saveWorkbook(wb, "setHeaderFooterExample.xlsx", overwrite = TRUE)

[Package openxlsx version 4.0.17 Index]