class Axlsx::HeaderFooter

@see Worksheet#initialize
@note The recommended way of managing header/footers is via Worksheet#header_footer
    
characters can be found here:
of plain text and control characters. A fairly comprehensive list of control
Headers and footers are generated using a string which is a combination
Header/Footer options for printing a worksheet. All settings are optional.

def initialize(options = {})

Options Hash: (**options)
  • different_first (Boolean) -- If true, will use the first header/footer on page 1. Otherwise, the odd header/footer is used.
  • 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)
  • first_footer (String) -- The content for footers on the first page.
  • first_header (String) -- The content for headers on the first page.
  • even_footer (String) -- The content for footers on even numbered pages.
  • even_header (String) -- The content for headers on even numbered pages.
  • odd_footer (String) -- The content for footers on odd numbered pages.
  • odd_header (String) -- The content for headers on odd numbered pages. 
def initialize(options = {})
  parse_options options
end

def set(options)

Parameters:
  • 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). 
def set(options)
  parse_options options
end

def to_xml_string(str = '')

Returns:
  • (String) -

Parameters:
  • str (String) -- 
def to_xml_string(str = '')
  serialized_tag('headerFooter', str) do
    serialized_element_attributes(str) do |value|
      value = ::CGI.escapeHTML(value)
    end
  end
end