Sha256: efb20562e1e6be119547cd72c283be4b42d177006ddcd7acfe179570217472d3
Contents?: true
Size: 1.39 KB
Versions: 5
Compression:
Stored size: 1.39 KB
Contents
# frozen_string_literal: true
module Axlsx
# The Protected Range class represents a set of cells in the worksheet
# @note the recommended way to manage protected ranges with via Worksheet#protect_range
# @see Worksheet#protect_range
class ProtectedRange
include Axlsx::OptionsParser
include Axlsx::SerializedAttributes
# Initializes a new protected range object
# @option [String] sqref The cell range reference to protect. This can be an absolute or a relateve range however, it only applies to the current sheet.
# @option [String] name An optional name for the protected name.
def initialize(options = {})
parse_options options
yield self if block_given?
end
serializable_attributes :sqref, :name
# The reference for the protected range
# @return [String]
attr_reader :sqref
# The name of the protected range
# @return [String]
attr_reader :name
# @see sqref
def sqref=(v)
Axlsx.validate_string(v)
@sqref = v
end
# @see name
def name=(v)
Axlsx.validate_string(v)
@name = v
end
# serializes the proteted range
# @param [String] str if this string object is provided we append
# our output to that object. Use this - it helps limit the number of
# objects created during serialization
def to_xml_string(str = +'')
serialized_tag 'protectedRange', str
end
end
end
Version data entries
5 entries across 5 versions & 2 rubygems