Class: AsposeCellsCloud::XmlSaveOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/models/xml_save_options.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ XmlSaveOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 125

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?(:'SheetIndexes')
      self.sheet_indexes = attributes[:'SheetIndexes']
  end
  if attributes.has_key?(:'ExportArea')
      self.export_area = attributes[:'ExportArea']
  end
  if attributes.has_key?(:'HasHeaderRow')
      self.has_header_row = attributes[:'HasHeaderRow']
  end
  if attributes.has_key?(:'XmlMapName')
      self.xml_map_name = attributes[:'XmlMapName']
  end
  if attributes.has_key?(:'SheetNameAsElementName')
      self.sheet_name_as_element_name = attributes[:'SheetNameAsElementName']
  end
  if attributes.has_key?(:'DataAsAttribute')
      self.data_as_attribute = attributes[:'DataAsAttribute']
  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
  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?(:'CheckExcelRestriction')
      self.check_excel_restriction = attributes[:'CheckExcelRestriction']
  end
  if attributes.has_key?(:'UpdateSmartArt')
      self.update_smart_art = attributes[:'UpdateSmartArt']
  end
  if attributes.has_key?(:'EncryptDocumentProperties')
      self.encrypt_document_properties = attributes[:'EncryptDocumentProperties']
  end

end

Instance Attribute Details

#cached_file_folder ⇒ Object

Returns the value of attribute cached_file_folder.



49
50
51
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 49

def cached_file_folder
  @cached_file_folder
end

#check_excel_restriction ⇒ Object

Returns the value of attribute check_excel_restriction.



67
68
69
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 67

def check_excel_restriction
  @check_excel_restriction
end

#clear_data ⇒ Object

Returns the value of attribute clear_data.



51
52
53
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 51

def clear_data
  @clear_data
end

#create_directory ⇒ Object

Returns the value of attribute create_directory.



53
54
55
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 53

def create_directory
  @create_directory
end

#data_as_attribute ⇒ Object

Returns the value of attribute data_as_attribute.



45
46
47
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 45

def data_as_attribute
  @data_as_attribute
end

#enable_http_compression ⇒ Object

Returns the value of attribute enable_http_compression.



55
56
57
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 55

def enable_http_compression
  @enable_http_compression
end

#encrypt_document_properties ⇒ Object

Returns the value of attribute encrypt_document_properties.



71
72
73
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 71

def encrypt_document_properties
  @encrypt_document_properties
end

#export_area ⇒ Object

Returns the value of attribute export_area.



37
38
39
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 37

def export_area
  @export_area
end

#has_header_row ⇒ Object

Returns the value of attribute has_header_row.



39
40
41
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 39

def has_header_row
  @has_header_row
end

#merge_areas ⇒ Object

Returns the value of attribute merge_areas.



63
64
65
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 63

def merge_areas
  @merge_areas
end

#refresh_chart_cache ⇒ Object

Returns the value of attribute refresh_chart_cache.



57
58
59
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 57

def refresh_chart_cache
  @refresh_chart_cache
end

#save_format ⇒ Object

Returns the value of attribute save_format.



47
48
49
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 47

def save_format
  @save_format
end

#sheet_indexes ⇒ Object

Returns the value of attribute sheet_indexes.



35
36
37
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 35

def sheet_indexes
  @sheet_indexes
end

#sheet_name_as_element_name ⇒ Object

Returns the value of attribute sheet_name_as_element_name.



43
44
45
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 43

def sheet_name_as_element_name
  @sheet_name_as_element_name
end

#sort_external_names ⇒ Object

Returns the value of attribute sort_external_names.



65
66
67
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 65

def sort_external_names
  @sort_external_names
end

#sort_names ⇒ Object

Returns the value of attribute sort_names.



59
60
61
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 59

def sort_names
  @sort_names
end

#update_smart_art ⇒ Object

Returns the value of attribute update_smart_art.



69
70
71
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 69

def update_smart_art
  @update_smart_art
end

#validate_merged_areas ⇒ Object

Returns the value of attribute validate_merged_areas.



61
62
63
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 61

def validate_merged_areas
  @validate_merged_areas
end

#xml_map_name ⇒ Object

Returns the value of attribute xml_map_name.



41
42
43
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 41

def xml_map_name
  @xml_map_name
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 74

def self.attribute_map
  {
    :'sheet_indexes' => :'SheetIndexes',
    :'export_area' => :'ExportArea',
    :'has_header_row' => :'HasHeaderRow',
    :'xml_map_name' => :'XmlMapName',
    :'sheet_name_as_element_name' => :'SheetNameAsElementName',
    :'data_as_attribute' => :'DataAsAttribute',
    :'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',
    :'merge_areas' => :'MergeAreas',
    :'sort_external_names' => :'SortExternalNames',
    :'check_excel_restriction' => :'CheckExcelRestriction',
    :'update_smart_art' => :'UpdateSmartArt',
    :'encrypt_document_properties' => :'EncryptDocumentProperties'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 99

def self.swagger_types
  {
    :'sheet_indexes' => :'Array<Integer>',
    :'export_area' => :'CellArea',
    :'has_header_row' => :'BOOLEAN',
    :'xml_map_name' => :'String',
    :'sheet_name_as_element_name' => :'BOOLEAN',
    :'data_as_attribute' => :'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',
    :'merge_areas' => :'BOOLEAN',
    :'sort_external_names' => :'BOOLEAN',
    :'check_excel_restriction' => :'BOOLEAN',
    :'update_smart_art' => :'BOOLEAN',
    :'encrypt_document_properties' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 283

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sheet_indexes == o.sheet_indexes &&
      export_area == o.export_area &&
      has_header_row == o.has_header_row &&
      xml_map_name == o.xml_map_name &&
      sheet_name_as_element_name == o.sheet_name_as_element_name &&
      data_as_attribute == o.data_as_attribute &&
      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 &&
      merge_areas == o.merge_areas &&
      sort_external_names == o.sort_external_names &&
      check_excel_restriction == o.check_excel_restriction &&
      update_smart_art == o.update_smart_art &&
      encrypt_document_properties == o.encrypt_document_properties 
      std_dev == o.std_dev
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 344

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 410

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 323

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


310
311
312
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 310

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



316
317
318
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 316

def hash
  [ sheet_indexes , export_area , has_header_row , xml_map_name , sheet_name_as_element_name , data_as_attribute , save_format , cached_file_folder , clear_data , create_directory , enable_http_compression , refresh_chart_cache , sort_names , validate_merged_areas , merge_areas , sort_external_names , check_excel_restriction , update_smart_art , encrypt_document_properties ].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 193

def list_invalid_properties
  invalid_properties = Array.new
  if @sheet_indexes.nil?
      invalid_properties.push("invalid value for 'sheet_indexes', sheet_indexes cannot be nil.")
  end
  if @export_area.nil?
      invalid_properties.push("invalid value for 'export_area', export_area cannot be nil.")
  end
  if @has_header_row.nil?
      invalid_properties.push("invalid value for 'has_header_row', has_header_row cannot be nil.")
  end
  if @xml_map_name.nil?
      invalid_properties.push("invalid value for 'xml_map_name', xml_map_name cannot be nil.")
  end
  if @sheet_name_as_element_name.nil?
      invalid_properties.push("invalid value for 'sheet_name_as_element_name', sheet_name_as_element_name cannot be nil.")
  end
  if @data_as_attribute.nil?
      invalid_properties.push("invalid value for 'data_as_attribute', data_as_attribute 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
  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 @check_excel_restriction.nil?
      invalid_properties.push("invalid value for 'check_excel_restriction', check_excel_restriction 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 @encrypt_document_properties.nil?
      invalid_properties.push("invalid value for 'encrypt_document_properties', encrypt_document_properties cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



390
391
392
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 390

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



396
397
398
399
400
401
402
403
404
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 396

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



384
385
386
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 384

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/aspose_cells_cloud/models/xml_save_options.rb', line 258

def valid?
  return false if @sheet_indexes.nil?
  return false if @export_area.nil?
  return false if @has_header_row.nil?
  return false if @xml_map_name.nil?
  return false if @sheet_name_as_element_name.nil?
  return false if @data_as_attribute.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 false if @merge_areas.nil?
  return false if @sort_external_names.nil?
  return false if @check_excel_restriction.nil?
  return false if @update_smart_art.nil?
  return false if @encrypt_document_properties.nil?
  return true
end