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



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
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 129

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?(:'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
  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

Instance Attribute Details

#attached_files_directory ⇒ Object

The directory that the attached files will be saved to. Only for saving to html stream.



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

def attached_files_directory
  @attached_files_directory
end

#attached_files_url_prefix ⇒ Object

Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.



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

def attached_files_url_prefix
  @attached_files_url_prefix
end

#cached_file_folder ⇒ Object

Returns the value of attribute cached_file_folder.



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

def cached_file_folder
  @cached_file_folder
end

#clear_data ⇒ Object

Returns the value of attribute clear_data.



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

def clear_data
  @clear_data
end

#create_directory ⇒ Object

Returns the value of attribute create_directory.



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

def create_directory
  @create_directory
end

#enable_http_compression ⇒ Object

Returns the value of attribute enable_http_compression.



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

def enable_http_compression
  @enable_http_compression
end

#encoding ⇒ Object

If not set,use Encoding.UTF8 as default enconding type.



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

def encoding
  @encoding
end

#export_active_worksheet_only ⇒ Object

Indicates if exporting the whole workbook to html file.



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

def export_active_worksheet_only
  @export_active_worksheet_only
end

#export_chart_image_format ⇒ Object

Get or set the format of chart image before exporting



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

def export_chart_image_format
  @export_chart_image_format
end

#export_images_as_base64 ⇒ Object

Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.



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

def export_images_as_base64
  @export_images_as_base64
end

#hidden_col_display_type ⇒ Object

Hidden column(the width of this column is 0) in excel,before save this into html format, if HtmlHiddenColDisplayType is “Remove”,the hidden column would ont been output, if the value is “Hidden”, the column would been output,but was hidden,the default value is “Hidden”



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

def hidden_col_display_type
  @hidden_col_display_type
end

#hidden_row_display_type ⇒ Object

Hidden row(the height of this row is 0) in excel,before save this into html format, if HtmlHiddenRowDisplayType is “Remove”,the hidden row would ont been output, if the value is “Hidden”, the row would been output,but was hidden,the default value is “Hidden”



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

def hidden_row_display_type
  @hidden_row_display_type
end

#html_cross_string_type ⇒ Object

Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format. By default the value is Default, so, for cross-cell strings, there is little difference between the html files created by Aspose.Cells and MS Excel. But the performance for creating large html files,setting the value to Cross would be several times faster than setting it to Default or Fit2Cell.



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

def html_cross_string_type
  @html_cross_string_type
end

#is_exp_image_to_temp_dir ⇒ Object

Indicates if export image files to temp directory. Only for saving to html stream.



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

def is_exp_image_to_temp_dir
  @is_exp_image_to_temp_dir
end

#page_title ⇒ Object

The title of the html page. Only for saving to html stream.



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

def page_title
  @page_title
end

#parse_html_tag_in_cell ⇒ Object

Parse html tag in cell,like ,as cell value,or as html tag,default is true



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

def parse_html_tag_in_cell
  @parse_html_tag_in_cell
end

#refresh_chart_cache ⇒ Object

Returns the value of attribute refresh_chart_cache.



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

def refresh_chart_cache
  @refresh_chart_cache
end

#save_format ⇒ Object

Returns the value of attribute save_format.



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

def save_format
  @save_format
end

#sort_names ⇒ Object

Returns the value of attribute sort_names.



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

def sort_names
  @sort_names
end

#validate_merged_areas ⇒ Object

Returns the value of attribute validate_merged_areas.



73
74
75
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 73

def validate_merged_areas
  @validate_merged_areas
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'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',
    :'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

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 102

def self.swagger_types
  {
    :'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',
    :'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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 294

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 356

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



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 422

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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 335

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [ 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 , 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 ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



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
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 200

def list_invalid_properties
  invalid_properties = Array.new
  if @attached_files_directory.nil?
      invalid_properties.push("invalid value for 'attached_files_directory', attached_files_directory cannot be nil.")
  end
  if @attached_files_url_prefix.nil?
      invalid_properties.push("invalid value for 'attached_files_url_prefix', attached_files_url_prefix cannot be nil.")
  end
  if @encoding.nil?
      invalid_properties.push("invalid value for 'encoding', encoding cannot be nil.")
  end
  if @export_active_worksheet_only.nil?
      invalid_properties.push("invalid value for 'export_active_worksheet_only', export_active_worksheet_only cannot be nil.")
  end
  if @export_chart_image_format.nil?
      invalid_properties.push("invalid value for 'export_chart_image_format', export_chart_image_format cannot be nil.")
  end
  if @export_images_as_base64.nil?
      invalid_properties.push("invalid value for 'export_images_as_base64', export_images_as_base64 cannot be nil.")
  end
  if @hidden_col_display_type.nil?
      invalid_properties.push("invalid value for 'hidden_col_display_type', hidden_col_display_type cannot be nil.")
  end
  if @hidden_row_display_type.nil?
      invalid_properties.push("invalid value for 'hidden_row_display_type', hidden_row_display_type cannot be nil.")
  end
  if @html_cross_string_type.nil?
      invalid_properties.push("invalid value for 'html_cross_string_type', html_cross_string_type cannot be nil.")
  end
  if @is_exp_image_to_temp_dir.nil?
      invalid_properties.push("invalid value for 'is_exp_image_to_temp_dir', is_exp_image_to_temp_dir cannot be nil.")
  end
  if @page_title.nil?
      invalid_properties.push("invalid value for 'page_title', page_title cannot be nil.")
  end
  if @parse_html_tag_in_cell.nil?
      invalid_properties.push("invalid value for 'parse_html_tag_in_cell', parse_html_tag_in_cell 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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



402
403
404
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 402

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



408
409
410
411
412
413
414
415
416
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 408

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



396
397
398
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 396

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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/aspose_cells_cloud/models/m_html_save_options.rb', line 268

def valid?
  return false if @attached_files_directory.nil?
  return false if @attached_files_url_prefix.nil?
  return false if @encoding.nil?
  return false if @export_active_worksheet_only.nil?
  return false if @export_chart_image_format.nil?
  return false if @export_images_as_base64.nil?
  return false if @hidden_col_display_type.nil?
  return false if @hidden_row_display_type.nil?
  return false if @html_cross_string_type.nil?
  return false if @is_exp_image_to_temp_dir.nil?
  return false if @page_title.nil?
  return false if @parse_html_tag_in_cell.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