class Axlsx::HeaderFooter

The recommended way of managing header/footers is via Worksheet#header_footer

Header/Footer options for printing a worksheet. All settings are optional.

Headers and footers are generated using a string which is a combination of plain text and control characters. A fairly comprehensive list of control characters can be found here:     

Creates a new HeaderFooter object


  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • odd_header (String)

    The content for headers on odd numbered pages.

  • odd_footer (String)

    The content for footers on odd numbered pages.

  • even_header (String)

    The content for headers on even numbered pages.

  • even_footer (String)

    The content for footers on even numbered pages.

  • first_header (String)

    The content for headers on the first page.

  • first_footer (String)

    The content for footers on the first page.

  • different_odd_even (Boolean)

    Setting this to true will show different headers/footers on odd and even pages. When false, the odd headers/footers are used on each page. (Default: false)

  • different_first (Boolean)

    If true, will use the first header/footer on page 1. Otherwise, the odd header/footer is used.

Set some or all header/footers at once.


  • options (Hash)

    The header/footer options to set (possible keys are :odd_header, :odd_footer, :even_header, :even_footer, :first_header, :first_footer, :different_odd_even, and :different_first).

Serializes the header/footer object.


  • str (String) (defaults to: '')

HeaderFooter is referenced in 0 repositories