class AsposeCellsCloud::Protection

Attributes

allow_deleting_column[RW]

Represents if the deletion of columns is allowed on a protected worksheet.

allow_deleting_row[RW]

Represents if the deletion of rows is allowed on a protected worksheet.

allow_editing_content[RW]

Represents if the user is allowed to edit contents of locked cells on a protected worksheet.

allow_editing_object[RW]

Represents if the user is allowed to manipulate drawing objects on a protected worksheet.

allow_editing_scenario[RW]

Represents if the user is allowed to edit scenarios on a protected worksheet.

allow_filtering[RW]

Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.

allow_formatting_cell[RW]

Represents if the formatting of cells is allowed on a protected worksheet.

allow_formatting_column[RW]

Represents if the formatting of columns is allowed on a protected worksheet

allow_formatting_row[RW]

Represents if the formatting of rows is allowed on a protected worksheet

allow_inserting_column[RW]

Represents if the insertion of columns is allowed on a protected worksheet

allow_inserting_row[RW]

Represents if the insertion of rows is allowed on a protected worksheet

allow_selecting_locked_cell[RW]

Represents if the user is allowed to select locked cells on a protected worksheet.

allow_selecting_unlocked_cell[RW]

Represents if the user is allowed to select unlocked cells on a protected worksheet.

allow_sorting[RW]

Represents if the sorting option is allowed on a protected worksheet.

allow_using_pivot_table[RW]

Represents if the user is allowed to manipulate pivot tables on a protected worksheet.

password[RW]

Represents the password to protect the worksheet.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/aspose_cells_cloud/models/protection.rb, line 70
def self.attribute_map
  {
    :'allow_deleting_column' => :'AllowDeletingColumn',
    :'allow_deleting_row' => :'AllowDeletingRow',
    :'allow_filtering' => :'AllowFiltering',
    :'allow_formatting_cell' => :'AllowFormattingCell',
    :'allow_formatting_column' => :'AllowFormattingColumn',
    :'allow_formatting_row' => :'AllowFormattingRow',
    :'allow_inserting_column' => :'AllowInsertingColumn',
    :'allow_inserting_hyperlink' => :'AllowInsertingHyperlink',
    :'allow_inserting_row' => :'AllowInsertingRow',
    :'allow_sorting' => :'AllowSorting',
    :'allow_using_pivot_table' => :'AllowUsingPivotTable',
    :'allow_editing_content' => :'AllowEditingContent',
    :'allow_editing_object' => :'AllowEditingObject',
    :'allow_editing_scenario' => :'AllowEditingScenario',
    :'password' => :'Password',
    :'allow_selecting_locked_cell' => :'AllowSelectingLockedCell',
    :'allow_selecting_unlocked_cell' => :'AllowSelectingUnlockedCell'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/aspose_cells_cloud/models/protection.rb, line 117
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'AllowDeletingColumn')
      self.allow_deleting_column = attributes[:'AllowDeletingColumn']
  end
  if attributes.has_key?(:'AllowDeletingRow')
      self.allow_deleting_row = attributes[:'AllowDeletingRow']
  end
  if attributes.has_key?(:'AllowFiltering')
      self.allow_filtering = attributes[:'AllowFiltering']
  end
  if attributes.has_key?(:'AllowFormattingCell')
      self.allow_formatting_cell = attributes[:'AllowFormattingCell']
  end
  if attributes.has_key?(:'AllowFormattingColumn')
      self.allow_formatting_column = attributes[:'AllowFormattingColumn']
  end
  if attributes.has_key?(:'AllowFormattingRow')
      self.allow_formatting_row = attributes[:'AllowFormattingRow']
  end
  if attributes.has_key?(:'AllowInsertingColumn')
      self.allow_inserting_column = attributes[:'AllowInsertingColumn']
  end
  if attributes.has_key?(:'AllowInsertingHyperlink')
      self.allow_inserting_hyperlink = attributes[:'AllowInsertingHyperlink']
  end
  if attributes.has_key?(:'AllowInsertingRow')
      self.allow_inserting_row = attributes[:'AllowInsertingRow']
  end
  if attributes.has_key?(:'AllowSorting')
      self.allow_sorting = attributes[:'AllowSorting']
  end
  if attributes.has_key?(:'AllowUsingPivotTable')
      self.allow_using_pivot_table = attributes[:'AllowUsingPivotTable']
  end
  if attributes.has_key?(:'AllowEditingContent')
      self.allow_editing_content = attributes[:'AllowEditingContent']
  end
  if attributes.has_key?(:'AllowEditingObject')
      self.allow_editing_object = attributes[:'AllowEditingObject']
  end
  if attributes.has_key?(:'AllowEditingScenario')
      self.allow_editing_scenario = attributes[:'AllowEditingScenario']
  end
  if attributes.has_key?(:'Password')
      self.password = attributes[:'Password']
  end
  if attributes.has_key?(:'AllowSelectingLockedCell')
      self.allow_selecting_locked_cell = attributes[:'AllowSelectingLockedCell']
  end
  if attributes.has_key?(:'AllowSelectingUnlockedCell')
      self.allow_selecting_unlocked_cell = attributes[:'AllowSelectingUnlockedCell']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_cells_cloud/models/protection.rb, line 93
def self.swagger_types
  {
    :'allow_deleting_column' => :'BOOLEAN',
    :'allow_deleting_row' => :'BOOLEAN',
    :'allow_filtering' => :'BOOLEAN',
    :'allow_formatting_cell' => :'BOOLEAN',
    :'allow_formatting_column' => :'BOOLEAN',
    :'allow_formatting_row' => :'BOOLEAN',
    :'allow_inserting_column' => :'BOOLEAN',
    :'allow_inserting_hyperlink' => :'BOOLEAN',
    :'allow_inserting_row' => :'BOOLEAN',
    :'allow_sorting' => :'BOOLEAN',
    :'allow_using_pivot_table' => :'BOOLEAN',
    :'allow_editing_content' => :'BOOLEAN',
    :'allow_editing_object' => :'BOOLEAN',
    :'allow_editing_scenario' => :'BOOLEAN',
    :'password' => :'String',
    :'allow_selecting_locked_cell' => :'BOOLEAN',
    :'allow_selecting_unlocked_cell' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose_cells_cloud/models/protection.rb, line 261
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_deleting_column == o.allow_deleting_column &&
      allow_deleting_row == o.allow_deleting_row &&
      allow_filtering == o.allow_filtering &&
      allow_formatting_cell == o.allow_formatting_cell &&
      allow_formatting_column == o.allow_formatting_column &&
      allow_formatting_row == o.allow_formatting_row &&
      allow_inserting_column == o.allow_inserting_column &&
      allow_inserting_hyperlink == o.allow_inserting_hyperlink &&
      allow_inserting_row == o.allow_inserting_row &&
      allow_sorting == o.allow_sorting &&
      allow_using_pivot_table == o.allow_using_pivot_table &&
      allow_editing_content == o.allow_editing_content &&
      allow_editing_object == o.allow_editing_object &&
      allow_editing_scenario == o.allow_editing_scenario &&
      password == o.password &&
      allow_selecting_locked_cell == o.allow_selecting_locked_cell &&
      allow_selecting_unlocked_cell == o.allow_selecting_unlocked_cell 
      std_dev == o.std_dev
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/aspose_cells_cloud/models/protection.rb, line 320
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = AsposeCellsCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/aspose_cells_cloud/models/protection.rb, line 386
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aspose_cells_cloud/models/protection.rb, line 299
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/aspose_cells_cloud/models/protection.rb, line 286
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose_cells_cloud/models/protection.rb, line 292
def hash
  [ allow_deleting_column , allow_deleting_row , allow_filtering , allow_formatting_cell , allow_formatting_column , allow_formatting_row , allow_inserting_column , allow_inserting_hyperlink , allow_inserting_row , allow_sorting , allow_using_pivot_table , allow_editing_content , allow_editing_object , allow_editing_scenario , password , allow_selecting_locked_cell , allow_selecting_unlocked_cell ].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/aspose_cells_cloud/models/protection.rb, line 179
def list_invalid_properties
  invalid_properties = Array.new
  if @allow_deleting_column.nil?
      invalid_properties.push("invalid value for 'allow_deleting_column', allow_deleting_column cannot be nil.")
  end
  if @allow_deleting_row.nil?
      invalid_properties.push("invalid value for 'allow_deleting_row', allow_deleting_row cannot be nil.")
  end
  if @allow_filtering.nil?
      invalid_properties.push("invalid value for 'allow_filtering', allow_filtering cannot be nil.")
  end
  if @allow_formatting_cell.nil?
      invalid_properties.push("invalid value for 'allow_formatting_cell', allow_formatting_cell cannot be nil.")
  end
  if @allow_formatting_column.nil?
      invalid_properties.push("invalid value for 'allow_formatting_column', allow_formatting_column cannot be nil.")
  end
  if @allow_formatting_row.nil?
      invalid_properties.push("invalid value for 'allow_formatting_row', allow_formatting_row cannot be nil.")
  end
  if @allow_inserting_column.nil?
      invalid_properties.push("invalid value for 'allow_inserting_column', allow_inserting_column cannot be nil.")
  end
  if @allow_inserting_hyperlink.nil?
      invalid_properties.push("invalid value for 'allow_inserting_hyperlink', allow_inserting_hyperlink cannot be nil.")
  end
  if @allow_inserting_row.nil?
      invalid_properties.push("invalid value for 'allow_inserting_row', allow_inserting_row cannot be nil.")
  end
  if @allow_sorting.nil?
      invalid_properties.push("invalid value for 'allow_sorting', allow_sorting cannot be nil.")
  end
  if @allow_using_pivot_table.nil?
      invalid_properties.push("invalid value for 'allow_using_pivot_table', allow_using_pivot_table cannot be nil.")
  end
  if @allow_editing_content.nil?
      invalid_properties.push("invalid value for 'allow_editing_content', allow_editing_content cannot be nil.")
  end
  if @allow_editing_object.nil?
      invalid_properties.push("invalid value for 'allow_editing_object', allow_editing_object cannot be nil.")
  end
  if @allow_editing_scenario.nil?
      invalid_properties.push("invalid value for 'allow_editing_scenario', allow_editing_scenario cannot be nil.")
  end
  if @password.nil?
      invalid_properties.push("invalid value for 'password', password cannot be nil.")
  end
  if @allow_selecting_locked_cell.nil?
      invalid_properties.push("invalid value for 'allow_selecting_locked_cell', allow_selecting_locked_cell cannot be nil.")
  end
  if @allow_selecting_unlocked_cell.nil?
      invalid_properties.push("invalid value for 'allow_selecting_unlocked_cell', allow_selecting_unlocked_cell cannot be nil.")
  end

  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose_cells_cloud/models/protection.rb, line 366
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/aspose_cells_cloud/models/protection.rb, line 372
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose_cells_cloud/models/protection.rb, line 360
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose_cells_cloud/models/protection.rb, line 238
def valid?
  return false if @allow_deleting_column.nil?
  return false if @allow_deleting_row.nil?
  return false if @allow_filtering.nil?
  return false if @allow_formatting_cell.nil?
  return false if @allow_formatting_column.nil?
  return false if @allow_formatting_row.nil?
  return false if @allow_inserting_column.nil?
  return false if @allow_inserting_hyperlink.nil?
  return false if @allow_inserting_row.nil?
  return false if @allow_sorting.nil?
  return false if @allow_using_pivot_table.nil?
  return false if @allow_editing_content.nil?
  return false if @allow_editing_object.nil?
  return false if @allow_editing_scenario.nil?
  return false if @password.nil?
  return false if @allow_selecting_locked_cell.nil?
  return false if @allow_selecting_unlocked_cell.nil?
  return true
end