Contents

# frozen_string_literal: true

module Axlsx
  # Page setup properties of the worksheet
  # This class name is not a typo, its spec.
  class PageSetUpPr
    include Axlsx::OptionsParser
    include Axlsx::SerializedAttributes

    # creates a new page setup properties object
    # @param [Hash] options
    # @option [Boolean] auto_page_breaks Flag indicating whether the sheet displays Automatic Page Breaks.
    # @option [Boolean] fit_to_page Flag indicating whether the Fit to Page print option is enabled.
    def initialize(options = {})
      parse_options options
    end

    serializable_attributes :auto_page_breaks, :fit_to_page

    attr_reader :auto_page_breaks
    attr_reader :fit_to_page

    # Flag indicating whether the Fit to Page print option is enabled.
    # @param [Boolean] value
    # @return [Boolean]
    def fit_to_page=(value)
      Axlsx.validate_boolean value
      @fit_to_page = value
    end

    # Flag indicating whether the sheet displays Automatic Page Breaks.
    # @param [Boolean] value
    # @return [Boolean]
    def auto_page_breaks=(value)
      Axlsx.validate_boolean value
      @auto_page_breaks = value
    end

    # serialize to xml
    def to_xml_string(str = +'')
      str << '<pageSetUpPr '
      serialized_attributes(str)
      str << '/>'
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
caxlsx-4.0.0	lib/axlsx/workbook/worksheet/page_set_up_pr.rb