class AsposeCellsCloud::OoxmlSaveOptions

Attributes

cached_file_folder[RW]
clear_data[RW]
compression_type[RW]

Gets and sets the compression type for ooxml file.

create_directory[RW]
embed_ooxml_as_ole_object[RW]

Indicates whether embedding Ooxml files of OleObject as ole object.

enable_http_compression[RW]
enable_zip64[RW]

Always use ZIP64 extensions when writing zip archives, even when unnecessary.

export_cell_name[RW]

Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file. If the output file may be accessed by SQL Server DTS, this value must be true. Setting the value to false will highly increase the performance and reduce the file size when creating large file. Default value is false.

refresh_chart_cache[RW]
save_format[RW]
sort_names[RW]
update_zoom[RW]

Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.

validate_merged_areas[RW]

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/ooxml_save_options.rb, line 62
def self.attribute_map
  {
    :'export_cell_name' => :'ExportCellName',
    :'update_zoom' => :'UpdateZoom',
    :'enable_zip64' => :'EnableZip64',
    :'embed_ooxml_as_ole_object' => :'EmbedOoxmlAsOleObject',
    :'compression_type' => :'CompressionType',
    :'save_format' => :'SaveFormat',
    :'cached_file_folder' => :'CachedFileFolder',
    :'clear_data' => :'ClearData',
    :'create_directory' => :'CreateDirectory',
    :'enable_http_compression' => :'EnableHTTPCompression',
    :'refresh_chart_cache' => :'RefreshChartCache',
    :'sort_names' => :'SortNames',
    :'validate_merged_areas' => :'ValidateMergedAreas'
  }
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/ooxml_save_options.rb, line 101
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?(:'ExportCellName')
      self.export_cell_name = attributes[:'ExportCellName']
  end
  if attributes.has_key?(:'UpdateZoom')
      self.update_zoom = attributes[:'UpdateZoom']
  end
  if attributes.has_key?(:'EnableZip64')
      self.enable_zip64 = attributes[:'EnableZip64']
  end
  if attributes.has_key?(:'EmbedOoxmlAsOleObject')
      self.embed_ooxml_as_ole_object = attributes[:'EmbedOoxmlAsOleObject']
  end
  if attributes.has_key?(:'CompressionType')
      self.compression_type = attributes[:'CompressionType']
  end
  if attributes.has_key?(:'SaveFormat')
      self.save_format = attributes[:'SaveFormat']
  end
  if attributes.has_key?(:'CachedFileFolder')
      self.cached_file_folder = attributes[:'CachedFileFolder']
  end
  if attributes.has_key?(:'ClearData')
      self.clear_data = attributes[:'ClearData']
  end
  if attributes.has_key?(:'CreateDirectory')
      self.create_directory = attributes[:'CreateDirectory']
  end
  if attributes.has_key?(:'EnableHTTPCompression')
      self.enable_http_compression = attributes[:'EnableHTTPCompression']
  end
  if attributes.has_key?(:'RefreshChartCache')
      self.refresh_chart_cache = attributes[:'RefreshChartCache']
  end
  if attributes.has_key?(:'SortNames')
      self.sort_names = attributes[:'SortNames']
  end
  if attributes.has_key?(:'ValidateMergedAreas')
      self.validate_merged_areas = attributes[:'ValidateMergedAreas']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_cells_cloud/models/ooxml_save_options.rb, line 81
def self.swagger_types
  {
    :'export_cell_name' => :'BOOLEAN',
    :'update_zoom' => :'BOOLEAN',
    :'enable_zip64' => :'BOOLEAN',
    :'embed_ooxml_as_ole_object' => :'BOOLEAN',
    :'compression_type' => :'String',
    :'save_format' => :'String',
    :'cached_file_folder' => :'String',
    :'clear_data' => :'BOOLEAN',
    :'create_directory' => :'BOOLEAN',
    :'enable_http_compression' => :'BOOLEAN',
    :'refresh_chart_cache' => :'BOOLEAN',
    :'sort_names' => :'BOOLEAN',
    :'validate_merged_areas' => :'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/ooxml_save_options.rb, line 217
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      export_cell_name == o.export_cell_name &&
      update_zoom == o.update_zoom &&
      enable_zip64 == o.enable_zip64 &&
      embed_ooxml_as_ole_object == o.embed_ooxml_as_ole_object &&
      compression_type == o.compression_type &&
      save_format == o.save_format &&
      cached_file_folder == o.cached_file_folder &&
      clear_data == o.clear_data &&
      create_directory == o.create_directory &&
      enable_http_compression == o.enable_http_compression &&
      refresh_chart_cache == o.refresh_chart_cache &&
      sort_names == o.sort_names &&
      validate_merged_areas == o.validate_merged_areas 
      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/ooxml_save_options.rb, line 272
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/ooxml_save_options.rb, line 338
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/ooxml_save_options.rb, line 251
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/ooxml_save_options.rb, line 238
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/ooxml_save_options.rb, line 244
def hash
  [ export_cell_name , update_zoom , enable_zip64 , embed_ooxml_as_ole_object , compression_type , save_format , cached_file_folder , clear_data , create_directory , enable_http_compression , refresh_chart_cache , sort_names , validate_merged_areas ].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/ooxml_save_options.rb, line 151
def list_invalid_properties
  invalid_properties = Array.new
  if @export_cell_name.nil?
      invalid_properties.push("invalid value for 'export_cell_name', export_cell_name cannot be nil.")
  end
  if @update_zoom.nil?
      invalid_properties.push("invalid value for 'update_zoom', update_zoom cannot be nil.")
  end
  if @enable_zip64.nil?
      invalid_properties.push("invalid value for 'enable_zip64', enable_zip64 cannot be nil.")
  end
  if @embed_ooxml_as_ole_object.nil?
      invalid_properties.push("invalid value for 'embed_ooxml_as_ole_object', embed_ooxml_as_ole_object cannot be nil.")
  end
  if @compression_type.nil?
      invalid_properties.push("invalid value for 'compression_type', compression_type cannot be nil.")
  end
  if @save_format.nil?
      invalid_properties.push("invalid value for 'save_format', save_format cannot be nil.")
  end
  if @cached_file_folder.nil?
      invalid_properties.push("invalid value for 'cached_file_folder', cached_file_folder cannot be nil.")
  end
  if @clear_data.nil?
      invalid_properties.push("invalid value for 'clear_data', clear_data cannot be nil.")
  end
  if @create_directory.nil?
      invalid_properties.push("invalid value for 'create_directory', create_directory cannot be nil.")
  end
  if @enable_http_compression.nil?
      invalid_properties.push("invalid value for 'enable_http_compression', enable_http_compression cannot be nil.")
  end
  if @refresh_chart_cache.nil?
      invalid_properties.push("invalid value for 'refresh_chart_cache', refresh_chart_cache cannot be nil.")
  end
  if @sort_names.nil?
      invalid_properties.push("invalid value for 'sort_names', sort_names cannot be nil.")
  end
  if @validate_merged_areas.nil?
      invalid_properties.push("invalid value for 'validate_merged_areas', validate_merged_areas 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/ooxml_save_options.rb, line 318
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/ooxml_save_options.rb, line 324
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/ooxml_save_options.rb, line 312
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/ooxml_save_options.rb, line 198
def valid?
  return false if @export_cell_name.nil?
  return false if @update_zoom.nil?
  return false if @enable_zip64.nil?
  return false if @embed_ooxml_as_ole_object.nil?
  return false if @compression_type.nil?
  return false if @save_format.nil?
  return false if @cached_file_folder.nil?
  return false if @clear_data.nil?
  return false if @create_directory.nil?
  return false if @enable_http_compression.nil?
  return false if @refresh_chart_cache.nil?
  return false if @sort_names.nil?
  return false if @validate_merged_areas.nil?
  return true
end