class AsposeCellsCloud::DocxSaveOptions

Attributes

all_columns_in_one_page_per_sheet[RW]
cached_file_folder[RW]
check_font_compatibility[RW]
check_workbook_default_font[RW]
clear_data[RW]
create_directory[RW]
default_edit_language[RW]
default_font[RW]
emf_render_setting[RW]
enable_http_compression[RW]
gridline_type[RW]
ignore_error[RW]
is_font_substitution_char_granularity[RW]
merge_areas[RW]
one_page_per_sheet[RW]
output_blank_page_when_nothing_to_print[RW]
page_count[RW]
page_index[RW]
printing_page_type[RW]
refresh_chart_cache[RW]
save_format[RW]
sort_external_names[RW]
sort_names[RW]
text_cross_type[RW]
update_smart_art[RW]
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/docx_save_options.rb, line 88
def self.attribute_map
  {
    :'default_font' => :'DefaultFont',
    :'check_workbook_default_font' => :'CheckWorkbookDefaultFont',
    :'check_font_compatibility' => :'CheckFontCompatibility',
    :'is_font_substitution_char_granularity' => :'IsFontSubstitutionCharGranularity',
    :'one_page_per_sheet' => :'OnePagePerSheet',
    :'all_columns_in_one_page_per_sheet' => :'AllColumnsInOnePagePerSheet',
    :'ignore_error' => :'IgnoreError',
    :'output_blank_page_when_nothing_to_print' => :'OutputBlankPageWhenNothingToPrint',
    :'page_index' => :'PageIndex',
    :'page_count' => :'PageCount',
    :'printing_page_type' => :'PrintingPageType',
    :'gridline_type' => :'GridlineType',
    :'text_cross_type' => :'TextCrossType',
    :'default_edit_language' => :'DefaultEditLanguage',
    :'emf_render_setting' => :'EmfRenderSetting',
    :'merge_areas' => :'MergeAreas',
    :'sort_external_names' => :'SortExternalNames',
    :'update_smart_art' => :'UpdateSmartArt',
    :'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/docx_save_options.rb, line 153
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?(:'DefaultFont')
      self.default_font = attributes[:'DefaultFont']
  end
  if attributes.has_key?(:'CheckWorkbookDefaultFont')
      self.check_workbook_default_font = attributes[:'CheckWorkbookDefaultFont']
  end
  if attributes.has_key?(:'CheckFontCompatibility')
      self.check_font_compatibility = attributes[:'CheckFontCompatibility']
  end
  if attributes.has_key?(:'IsFontSubstitutionCharGranularity')
      self.is_font_substitution_char_granularity = attributes[:'IsFontSubstitutionCharGranularity']
  end
  if attributes.has_key?(:'OnePagePerSheet')
      self.one_page_per_sheet = attributes[:'OnePagePerSheet']
  end
  if attributes.has_key?(:'AllColumnsInOnePagePerSheet')
      self.all_columns_in_one_page_per_sheet = attributes[:'AllColumnsInOnePagePerSheet']
  end
  if attributes.has_key?(:'IgnoreError')
      self.ignore_error = attributes[:'IgnoreError']
  end
  if attributes.has_key?(:'OutputBlankPageWhenNothingToPrint')
      self.output_blank_page_when_nothing_to_print = attributes[:'OutputBlankPageWhenNothingToPrint']
  end
  if attributes.has_key?(:'PageIndex')
      self.page_index = attributes[:'PageIndex']
  end
  if attributes.has_key?(:'PageCount')
      self.page_count = attributes[:'PageCount']
  end
  if attributes.has_key?(:'PrintingPageType')
      self.printing_page_type = attributes[:'PrintingPageType']
  end
  if attributes.has_key?(:'GridlineType')
      self.gridline_type = attributes[:'GridlineType']
  end
  if attributes.has_key?(:'TextCrossType')
      self.text_cross_type = attributes[:'TextCrossType']
  end
  if attributes.has_key?(:'DefaultEditLanguage')
      self.default_edit_language = attributes[:'DefaultEditLanguage']
  end
  if attributes.has_key?(:'EmfRenderSetting')
      self.emf_render_setting = attributes[:'EmfRenderSetting']
  end
  if attributes.has_key?(:'MergeAreas')
      self.merge_areas = attributes[:'MergeAreas']
  end
  if attributes.has_key?(:'SortExternalNames')
      self.sort_external_names = attributes[:'SortExternalNames']
  end
  if attributes.has_key?(:'UpdateSmartArt')
      self.update_smart_art = attributes[:'UpdateSmartArt']
  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/docx_save_options.rb, line 120
def self.swagger_types
  {
    :'default_font' => :'String',
    :'check_workbook_default_font' => :'BOOLEAN',
    :'check_font_compatibility' => :'BOOLEAN',
    :'is_font_substitution_char_granularity' => :'BOOLEAN',
    :'one_page_per_sheet' => :'BOOLEAN',
    :'all_columns_in_one_page_per_sheet' => :'BOOLEAN',
    :'ignore_error' => :'BOOLEAN',
    :'output_blank_page_when_nothing_to_print' => :'BOOLEAN',
    :'page_index' => :'Integer',
    :'page_count' => :'Integer',
    :'printing_page_type' => :'String',
    :'gridline_type' => :'String',
    :'text_cross_type' => :'String',
    :'default_edit_language' => :'String',
    :'emf_render_setting' => :'String',
    :'merge_areas' => :'BOOLEAN',
    :'sort_external_names' => :'BOOLEAN',
    :'update_smart_art' => :'BOOLEAN',
    :'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/docx_save_options.rb, line 360
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_font == o.default_font &&
      check_workbook_default_font == o.check_workbook_default_font &&
      check_font_compatibility == o.check_font_compatibility &&
      is_font_substitution_char_granularity == o.is_font_substitution_char_granularity &&
      one_page_per_sheet == o.one_page_per_sheet &&
      all_columns_in_one_page_per_sheet == o.all_columns_in_one_page_per_sheet &&
      ignore_error == o.ignore_error &&
      output_blank_page_when_nothing_to_print == o.output_blank_page_when_nothing_to_print &&
      page_index == o.page_index &&
      page_count == o.page_count &&
      printing_page_type == o.printing_page_type &&
      gridline_type == o.gridline_type &&
      text_cross_type == o.text_cross_type &&
      default_edit_language == o.default_edit_language &&
      emf_render_setting == o.emf_render_setting &&
      merge_areas == o.merge_areas &&
      sort_external_names == o.sort_external_names &&
      update_smart_art == o.update_smart_art &&
      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/docx_save_options.rb, line 428
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/docx_save_options.rb, line 494
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/docx_save_options.rb, line 407
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/docx_save_options.rb, line 394
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/docx_save_options.rb, line 400
def hash
  [ default_font , check_workbook_default_font , check_font_compatibility , is_font_substitution_char_granularity , one_page_per_sheet , all_columns_in_one_page_per_sheet , ignore_error , output_blank_page_when_nothing_to_print , page_index , page_count , printing_page_type , gridline_type , text_cross_type , default_edit_language , emf_render_setting , merge_areas , sort_external_names , update_smart_art , 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/docx_save_options.rb, line 242
def list_invalid_properties
  invalid_properties = Array.new
  if @default_font.nil?
      invalid_properties.push("invalid value for 'default_font', default_font cannot be nil.")
  end
  if @check_workbook_default_font.nil?
      invalid_properties.push("invalid value for 'check_workbook_default_font', check_workbook_default_font cannot be nil.")
  end
  if @check_font_compatibility.nil?
      invalid_properties.push("invalid value for 'check_font_compatibility', check_font_compatibility cannot be nil.")
  end
  if @is_font_substitution_char_granularity.nil?
      invalid_properties.push("invalid value for 'is_font_substitution_char_granularity', is_font_substitution_char_granularity cannot be nil.")
  end
  if @one_page_per_sheet.nil?
      invalid_properties.push("invalid value for 'one_page_per_sheet', one_page_per_sheet cannot be nil.")
  end
  if @all_columns_in_one_page_per_sheet.nil?
      invalid_properties.push("invalid value for 'all_columns_in_one_page_per_sheet', all_columns_in_one_page_per_sheet cannot be nil.")
  end
  if @ignore_error.nil?
      invalid_properties.push("invalid value for 'ignore_error', ignore_error cannot be nil.")
  end
  if @output_blank_page_when_nothing_to_print.nil?
      invalid_properties.push("invalid value for 'output_blank_page_when_nothing_to_print', output_blank_page_when_nothing_to_print cannot be nil.")
  end
  if @page_index.nil?
      invalid_properties.push("invalid value for 'page_index', page_index cannot be nil.")
  end
  if @page_count.nil?
      invalid_properties.push("invalid value for 'page_count', page_count cannot be nil.")
  end
  if @printing_page_type.nil?
      invalid_properties.push("invalid value for 'printing_page_type', printing_page_type cannot be nil.")
  end
  if @gridline_type.nil?
      invalid_properties.push("invalid value for 'gridline_type', gridline_type cannot be nil.")
  end
  if @text_cross_type.nil?
      invalid_properties.push("invalid value for 'text_cross_type', text_cross_type cannot be nil.")
  end
  if @default_edit_language.nil?
      invalid_properties.push("invalid value for 'default_edit_language', default_edit_language cannot be nil.")
  end
  if @emf_render_setting.nil?
      invalid_properties.push("invalid value for 'emf_render_setting', emf_render_setting cannot be nil.")
  end
  if @merge_areas.nil?
      invalid_properties.push("invalid value for 'merge_areas', merge_areas cannot be nil.")
  end
  if @sort_external_names.nil?
      invalid_properties.push("invalid value for 'sort_external_names', sort_external_names cannot be nil.")
  end
  if @update_smart_art.nil?
      invalid_properties.push("invalid value for 'update_smart_art', update_smart_art 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/docx_save_options.rb, line 474
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/docx_save_options.rb, line 480
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/docx_save_options.rb, line 468
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/docx_save_options.rb, line 328
def valid?
  return false if @default_font.nil?
  return false if @check_workbook_default_font.nil?
  return false if @check_font_compatibility.nil?
  return false if @is_font_substitution_char_granularity.nil?
  return false if @one_page_per_sheet.nil?
  return false if @all_columns_in_one_page_per_sheet.nil?
  return false if @ignore_error.nil?
  return false if @output_blank_page_when_nothing_to_print.nil?
  return false if @page_index.nil?
  return false if @page_count.nil?
  return false if @printing_page_type.nil?
  return false if @gridline_type.nil?
  return false if @text_cross_type.nil?
  return false if @default_edit_language.nil?
  return false if @emf_render_setting.nil?
  return false if @merge_areas.nil?
  return false if @sort_external_names.nil?
  return false if @update_smart_art.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