Class: AsposeCellsCloud::MHtmlSaveOptions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MHtmlSaveOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



117
118
119
120
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.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?(:'EnableHTTPCompression')
    self.enable_http_compression = attributes[:'EnableHTTPCompression']
  end

  if attributes.has_key?(:'SaveFormat')
    self.save_format = attributes[:'SaveFormat']
  end

  if attributes.has_key?(:'ClearData')
    self.clear_data = attributes[:'ClearData']
  end

  if attributes.has_key?(:'CachedFileFolder')
    self.cached_file_folder = attributes[:'CachedFileFolder']
  end

  if attributes.has_key?(:'ValidateMergedAreas')
    self.validate_merged_areas = attributes[:'ValidateMergedAreas']
  end

  if attributes.has_key?(:'RefreshChartCache')
    self.refresh_chart_cache = attributes[:'RefreshChartCache']
  end

  if attributes.has_key?(:'CreateDirectory')
    self.create_directory = attributes[:'CreateDirectory']
  end

  if attributes.has_key?(:'SortNames')
    self.sort_names = attributes[:'SortNames']
  end

  if attributes.has_key?(:'AttachedFilesDirectory')
    self.attached_files_directory = attributes[:'AttachedFilesDirectory']
  end

  if attributes.has_key?(:'AttachedFilesUrlPrefix')
    self.attached_files_url_prefix = attributes[:'AttachedFilesUrlPrefix']
  end

  if attributes.has_key?(:'Encoding')
    self.encoding = attributes[:'Encoding']
  end

  if attributes.has_key?(:'ExportActiveWorksheetOnly')
    self.export_active_worksheet_only = attributes[:'ExportActiveWorksheetOnly']
  end

  if attributes.has_key?(:'ExportChartImageFormat')
    self.export_chart_image_format = attributes[:'ExportChartImageFormat']
  end

  if attributes.has_key?(:'ExportImagesAsBase64')
    self.export_images_as_base64 = attributes[:'ExportImagesAsBase64']
  end

  if attributes.has_key?(:'HiddenColDisplayType')
    self.hidden_col_display_type = attributes[:'HiddenColDisplayType']
  end

  if attributes.has_key?(:'HiddenRowDisplayType')
    self.hidden_row_display_type = attributes[:'HiddenRowDisplayType']
  end

  if attributes.has_key?(:'HtmlCrossStringType')
    self.html_cross_string_type = attributes[:'HtmlCrossStringType']
  end

  if attributes.has_key?(:'IsExpImageToTempDir')
    self.is_exp_image_to_temp_dir = attributes[:'IsExpImageToTempDir']
  end

  if attributes.has_key?(:'PageTitle')
    self.page_title = attributes[:'PageTitle']
  end

  if attributes.has_key?(:'ParseHtmlTagInCell')
    self.parse_html_tag_in_cell = attributes[:'ParseHtmlTagInCell']
  end

end

Instance Attribute Details

#attached_files_directory ⇒ Object

Returns the value of attribute attached_files_directory.



38
39
40
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 38

def attached_files_directory
  @attached_files_directory
end

#attached_files_url_prefix ⇒ Object

Returns the value of attribute attached_files_url_prefix.



40
41
42
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 40

def attached_files_url_prefix
  @attached_files_url_prefix
end

#cached_file_folder ⇒ Object

The cached file folder is used to store some large data.



26
27
28
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 26

def cached_file_folder
  @cached_file_folder
end

#clear_data ⇒ Object

Make the workbook empty after saving the file.



23
24
25
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 23

def clear_data
  @clear_data
end

#create_directory ⇒ Object

If true and the directory does not exist, the directory will be automatically created before saving the file.



34
35
36
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 34

def create_directory
  @create_directory
end

#enable_http_compression ⇒ Object

Returns the value of attribute enable_http_compression.



18
19
20
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 18

def enable_http_compression
  @enable_http_compression
end

#encoding ⇒ Object

Returns the value of attribute encoding.



42
43
44
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 42

def encoding
  @encoding
end

#export_active_worksheet_only ⇒ Object

Returns the value of attribute export_active_worksheet_only.



44
45
46
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 44

def export_active_worksheet_only
  @export_active_worksheet_only
end

#export_chart_image_format ⇒ Object

Returns the value of attribute export_chart_image_format.



46
47
48
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 46

def export_chart_image_format
  @export_chart_image_format
end

#export_images_as_base64 ⇒ Object

Returns the value of attribute export_images_as_base64.



48
49
50
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 48

def export_images_as_base64
  @export_images_as_base64
end

#hidden_col_display_type ⇒ Object

Returns the value of attribute hidden_col_display_type.



50
51
52
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 50

def hidden_col_display_type
  @hidden_col_display_type
end

#hidden_row_display_type ⇒ Object

Returns the value of attribute hidden_row_display_type.



52
53
54
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 52

def hidden_row_display_type
  @hidden_row_display_type
end

#html_cross_string_type ⇒ Object

Returns the value of attribute html_cross_string_type.



54
55
56
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 54

def html_cross_string_type
  @html_cross_string_type
end

#is_exp_image_to_temp_dir ⇒ Object

Returns the value of attribute is_exp_image_to_temp_dir.



56
57
58
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 56

def is_exp_image_to_temp_dir
  @is_exp_image_to_temp_dir
end

#page_title ⇒ Object

Returns the value of attribute page_title.



58
59
60
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 58

def page_title
  @page_title
end

#parse_html_tag_in_cell ⇒ Object

Returns the value of attribute parse_html_tag_in_cell.



60
61
62
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 60

def parse_html_tag_in_cell
  @parse_html_tag_in_cell
end

#refresh_chart_cache ⇒ Object

Returns the value of attribute refresh_chart_cache.



31
32
33
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 31

def refresh_chart_cache
  @refresh_chart_cache
end

#save_format ⇒ Object

Returns the value of attribute save_format.



20
21
22
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 20

def save_format
  @save_format
end

#sort_names ⇒ Object

Returns the value of attribute sort_names.



36
37
38
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 36

def sort_names
  @sort_names
end

#validate_merged_areas ⇒ Object

Indicates whether validate merged areas before saving the file. The default value is false.



29
30
31
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 29

def validate_merged_areas
  @validate_merged_areas
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 64

def self.attribute_map
  {
    :'enable_http_compression' => :'EnableHTTPCompression',
    :'save_format' => :'SaveFormat',
    :'clear_data' => :'ClearData',
    :'cached_file_folder' => :'CachedFileFolder',
    :'validate_merged_areas' => :'ValidateMergedAreas',
    :'refresh_chart_cache' => :'RefreshChartCache',
    :'create_directory' => :'CreateDirectory',
    :'sort_names' => :'SortNames',
    :'attached_files_directory' => :'AttachedFilesDirectory',
    :'attached_files_url_prefix' => :'AttachedFilesUrlPrefix',
    :'encoding' => :'Encoding',
    :'export_active_worksheet_only' => :'ExportActiveWorksheetOnly',
    :'export_chart_image_format' => :'ExportChartImageFormat',
    :'export_images_as_base64' => :'ExportImagesAsBase64',
    :'hidden_col_display_type' => :'HiddenColDisplayType',
    :'hidden_row_display_type' => :'HiddenRowDisplayType',
    :'html_cross_string_type' => :'HtmlCrossStringType',
    :'is_exp_image_to_temp_dir' => :'IsExpImageToTempDir',
    :'page_title' => :'PageTitle',
    :'parse_html_tag_in_cell' => :'ParseHtmlTagInCell'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 90

def self.swagger_types
  {
    :'enable_http_compression' => :'BOOLEAN',
    :'save_format' => :'String',
    :'clear_data' => :'BOOLEAN',
    :'cached_file_folder' => :'String',
    :'validate_merged_areas' => :'BOOLEAN',
    :'refresh_chart_cache' => :'BOOLEAN',
    :'create_directory' => :'BOOLEAN',
    :'sort_names' => :'BOOLEAN',
    :'attached_files_directory' => :'String',
    :'attached_files_url_prefix' => :'String',
    :'encoding' => :'String',
    :'export_active_worksheet_only' => :'BOOLEAN',
    :'export_chart_image_format' => :'String',
    :'export_images_as_base64' => :'BOOLEAN',
    :'hidden_col_display_type' => :'String',
    :'hidden_row_display_type' => :'String',
    :'html_cross_string_type' => :'String',
    :'is_exp_image_to_temp_dir' => :'BOOLEAN',
    :'page_title' => :'String',
    :'parse_html_tag_in_cell' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 220

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enable_http_compression == o.enable_http_compression &&
      save_format == o.save_format &&
      clear_data == o.clear_data &&
      cached_file_folder == o.cached_file_folder &&
      validate_merged_areas == o.validate_merged_areas &&
      refresh_chart_cache == o.refresh_chart_cache &&
      create_directory == o.create_directory &&
      sort_names == o.sort_names &&
      attached_files_directory == o.attached_files_directory &&
      attached_files_url_prefix == o.attached_files_url_prefix &&
      encoding == o.encoding &&
      export_active_worksheet_only == o.export_active_worksheet_only &&
      export_chart_image_format == o.export_chart_image_format &&
      export_images_as_base64 == o.export_images_as_base64 &&
      hidden_col_display_type == o.hidden_col_display_type &&
      hidden_row_display_type == o.hidden_row_display_type &&
      html_cross_string_type == o.html_cross_string_type &&
      is_exp_image_to_temp_dir == o.is_exp_image_to_temp_dir &&
      page_title == o.page_title &&
      parse_html_tag_in_cell == o.parse_html_tag_in_cell
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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 281

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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 347

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 260

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


247
248
249
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 253

def hash
  [enable_http_compression, save_format, clear_data, cached_file_folder, validate_merged_areas, refresh_chart_cache, create_directory, sort_names, attached_files_directory, attached_files_url_prefix, encoding, export_active_worksheet_only, export_chart_image_format, export_images_as_base64, hidden_col_display_type, hidden_row_display_type, html_cross_string_type, is_exp_image_to_temp_dir, page_title, parse_html_tag_in_cell].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



207
208
209
210
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 207

def list_invalid_properties
  invalid_properties = Array.new
  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



327
328
329
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 327

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



333
334
335
336
337
338
339
340
341
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 333

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



321
322
323
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 321

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



214
215
216
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 214

def valid?
  return true
end