Class: AsposeCellsCloud::OoxmlSaveOptions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OoxmlSaveOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



121
122
123
124
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
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 121

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
  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.



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

def cached_file_folder
  @cached_file_folder
end

#check_excel_restriction ⇒ Object

Returns the value of attribute check_excel_restriction.



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

def check_excel_restriction
  @check_excel_restriction
end

#clear_data ⇒ Object

Returns the value of attribute clear_data.



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

def clear_data
  @clear_data
end

#compression_type ⇒ Object

Gets and sets the compression type for ooxml file.



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

def compression_type
  @compression_type
end

#create_directory ⇒ Object

Returns the value of attribute create_directory.



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

def create_directory
  @create_directory
end

#embed_ooxml_as_ole_object ⇒ Object

Indicates whether embedding Ooxml files of OleObject as ole object.



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

def embed_ooxml_as_ole_object
  @embed_ooxml_as_ole_object
end

#enable_http_compression ⇒ Object

Returns the value of attribute enable_http_compression.



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

def enable_http_compression
  @enable_http_compression
end

#enable_zip64 ⇒ Object

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



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

def enable_zip64
  @enable_zip64
end

#encrypt_document_properties ⇒ Object

Returns the value of attribute encrypt_document_properties.



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

def encrypt_document_properties
  @encrypt_document_properties
end

#export_cell_name ⇒ Object

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.



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

def export_cell_name
  @export_cell_name
end

#merge_areas ⇒ Object

Returns the value of attribute merge_areas.



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

def merge_areas
  @merge_areas
end

#refresh_chart_cache ⇒ Object

Returns the value of attribute refresh_chart_cache.



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

def refresh_chart_cache
  @refresh_chart_cache
end

#save_format ⇒ Object

Returns the value of attribute save_format.



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

def save_format
  @save_format
end

#sort_external_names ⇒ Object

Returns the value of attribute sort_external_names.



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

def sort_external_names
  @sort_external_names
end

#sort_names ⇒ Object

Returns the value of attribute sort_names.



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

def sort_names
  @sort_names
end

#update_smart_art ⇒ Object

Returns the value of attribute update_smart_art.



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

def update_smart_art
  @update_smart_art
end

#update_zoom ⇒ Object

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



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

def update_zoom
  @update_zoom
end

#validate_merged_areas ⇒ Object

Returns the value of attribute validate_merged_areas.



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

def validate_merged_areas
  @validate_merged_areas
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    :'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.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 96

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',
    :'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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 272

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 &&
      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



332
333
334
335
336
337
338
339
340
341
342
343
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
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 332

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



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 398

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 311

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


298
299
300
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 298

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



304
305
306
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 304

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 , 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



186
187
188
189
190
191
192
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
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 186

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



378
379
380
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 378

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



384
385
386
387
388
389
390
391
392
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 384

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



372
373
374
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 372

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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/aspose_cells_cloud/models/ooxml_save_options.rb', line 248

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