Contents

module Axlsx
  # CellProtection stores information about locking or hiding cells in spreadsheet.
  # @note Using Styles#add_style is the recommended way to manage cell protection.
  # @see Styles#add_style
  class CellProtection
    
    # specifies locking for cells that have the style containing this protection
    # @return [Boolean]
    attr_reader :hidden

    # specifies if the cells that have the style containing this protection
    # @return [Boolean]
    attr_reader :locked

    # Creates a new CellProtection
    # @option options [Boolean] hidden value for hidden protection
    # @option options [Boolean] locked value for locked protection
    def initialize(options={})
      options.each do |o|
        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
      end
    end

    # @see hidden
    def hidden=(v) Axlsx::validate_boolean v; @hidden = v end    
    # @see locked
    def locked=(v) Axlsx::validate_boolean v; @locked = v end    

    # Serializes the cell protection
    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
    # @return [String]
    def to_xml(xml)
      xml.protection(self.instance_values)
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
axlsx-1.0.16	lib/axlsx/stylesheet/cell_protection.rb
axlsx-1.0.15	lib/axlsx/stylesheet/cell_protection.rb
axlsx-1.0.14	lib/axlsx/stylesheet/cell_protection.rb
axlsx-1.0.13	lib/axlsx/stylesheet/cell_protection.rb
axlsx-1.0.11	lib/axlsx/stylesheet/cell_protection.rb
axlsx-1.0.10	lib/axlsx/stylesheet/cell_protection.rb
axlsx-1.0.10a	lib/axlsx/stylesheet/cell_protection.rb
axlsx-1.0.9	lib/axlsx/stylesheet/cell_protection.rb