class Axlsx::HeaderFooter

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: github.com/randym/axlsx/blob/master/notes_on_header_footer.md      @note The recommended way of managing header/footers is via Worksheet#header_footer @see Worksheet#initialize

Public Class Methods

new(options = {}) click to toggle source

Creates a new HeaderFooter object @option options [String] odd_header The content for headers on odd numbered pages. @option options [String] odd_footer The content for footers on odd numbered pages. @option options [String] even_header The content for headers on even numbered pages. @option options [String] even_footer The content for footers on even numbered pages. @option options [String] first_header The content for headers on the first page. @option options [String] first_footer The content for footers on the first page. @option options [Boolean] different_odd_even 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) @option options [Boolean] different_first If true, will use the first header/footer on page 1. Otherwise, the odd header/footer is used.

# File lib/axlsx/workbook/worksheet/header_footer.rb, line 26
def initialize(options = {})
  parse_options options
end

Public Instance Methods

set(options) click to toggle source

Set some or all header/footers at once. @param [Hash] options 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).

# File lib/axlsx/workbook/worksheet/header_footer.rb, line 37
def set(options)
  parse_options options
end
to_xml_string(str = '') click to toggle source

Serializes the header/footer object. @param [String] str @return [String]

# File lib/axlsx/workbook/worksheet/header_footer.rb, line 44
def to_xml_string(str = '')
  serialized_tag('headerFooter', str) do
    serialized_element_attributes(str) do |value|
      value = ::CGI.escapeHTML(value)
    end
  end
end