Class: AsposeCellsCloud::HtmlSaveOptions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HtmlSaveOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 237

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?(:'ExportPageHeaders')
      self.export_page_headers = attributes[:'ExportPageHeaders']
  end
  if attributes.has_key?(:'ExportPageFooters')
      self.export_page_footers = attributes[:'ExportPageFooters']
  end
  if attributes.has_key?(:'ExportRowColumnHeadings')
      self.export_row_column_headings = attributes[:'ExportRowColumnHeadings']
  end
  if attributes.has_key?(:'ShowAllSheets')
      self.show_all_sheets = attributes[:'ShowAllSheets']
  end
  if attributes.has_key?(:'ImageOptions')
      self.image_options = attributes[:'ImageOptions']
  end
  if attributes.has_key?(:'SaveAsSingleFile')
      self.save_as_single_file = attributes[:'SaveAsSingleFile']
  end
  if attributes.has_key?(:'ExportHiddenWorksheet')
      self.export_hidden_worksheet = attributes[:'ExportHiddenWorksheet']
  end
  if attributes.has_key?(:'ExportGridLines')
      self.export_grid_lines = attributes[:'ExportGridLines']
  end
  if attributes.has_key?(:'PresentationPreference')
      self.presentation_preference = attributes[:'PresentationPreference']
  end
  if attributes.has_key?(:'CellCssPrefix')
      self.cell_css_prefix = attributes[:'CellCssPrefix']
  end
  if attributes.has_key?(:'TableCssId')
      self.table_css_id = attributes[:'TableCssId']
  end
  if attributes.has_key?(:'IsFullPathLink')
      self.is_full_path_link = attributes[:'IsFullPathLink']
  end
  if attributes.has_key?(:'ExportWorksheetCSSSeparately')
      self.export_worksheet_css_separately = attributes[:'ExportWorksheetCSSSeparately']
  end
  if attributes.has_key?(:'ExportSimilarBorderStyle')
      self.export_similar_border_style = attributes[:'ExportSimilarBorderStyle']
  end
  if attributes.has_key?(:'MergeEmptyTdForcely')
      self.merge_empty_td_forcely = attributes[:'MergeEmptyTdForcely']
  end
  if attributes.has_key?(:'ExportCellCoordinate')
      self.export_cell_coordinate = attributes[:'ExportCellCoordinate']
  end
  if attributes.has_key?(:'ExportExtraHeadings')
      self.export_extra_headings = attributes[:'ExportExtraHeadings']
  end
  if attributes.has_key?(:'ExportHeadings')
      self.export_headings = attributes[:'ExportHeadings']
  end
  if attributes.has_key?(:'ExportFormula')
      self.export_formula = attributes[:'ExportFormula']
  end
  if attributes.has_key?(:'AddTooltipText')
      self.add_tooltip_text = attributes[:'AddTooltipText']
  end
  if attributes.has_key?(:'ExportBogusRowData')
      self.export_bogus_row_data = attributes[:'ExportBogusRowData']
  end
  if attributes.has_key?(:'ExcludeUnusedStyles')
      self.exclude_unused_styles = attributes[:'ExcludeUnusedStyles']
  end
  if attributes.has_key?(:'ExportDocumentProperties')
      self.export_document_properties = attributes[:'ExportDocumentProperties']
  end
  if attributes.has_key?(:'ExportWorksheetProperties')
      self.export_worksheet_properties = attributes[:'ExportWorksheetProperties']
  end
  if attributes.has_key?(:'ExportWorkbookProperties')
      self.export_workbook_properties = attributes[:'ExportWorkbookProperties']
  end
  if attributes.has_key?(:'ExportFrameScriptsAndProperties')
      self.export_frame_scripts_and_properties = attributes[:'ExportFrameScriptsAndProperties']
  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
  if attributes.has_key?(:'CellNameAttribute')
      self.cell_name_attribute = attributes[:'CellNameAttribute']
  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

#add_tooltip_text ⇒ Object

Indicates whether adding tooltip text when the data can’t be fully displayed.



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

def add_tooltip_text
  @add_tooltip_text
end

#attached_files_directory ⇒ Object

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



87
88
89
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 87

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.



89
90
91
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 89

def attached_files_url_prefix
  @attached_files_url_prefix
end

#cached_file_folder ⇒ Object

Returns the value of attribute cached_file_folder.



115
116
117
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 115

def cached_file_folder
  @cached_file_folder
end

#cell_css_prefix ⇒ Object

Gets and sets the prefix of the css name,the default value is “”.



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

def cell_css_prefix
  @cell_css_prefix
end

#cell_name_attribute ⇒ Object

Returns the value of attribute cell_name_attribute.



111
112
113
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 111

def cell_name_attribute
  @cell_name_attribute
end

#clear_data ⇒ Object

Returns the value of attribute clear_data.



117
118
119
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 117

def clear_data
  @clear_data
end

#create_directory ⇒ Object

Returns the value of attribute create_directory.



119
120
121
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 119

def create_directory
  @create_directory
end

#enable_http_compression ⇒ Object

Returns the value of attribute enable_http_compression.



121
122
123
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 121

def enable_http_compression
  @enable_http_compression
end

#encoding ⇒ Object

Returns the value of attribute encoding.



91
92
93
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 91

def encoding
  @encoding
end

#exclude_unused_styles ⇒ Object

Indicating whether excluding unused styles.The default value is false.If you want to import the html or mht file to excel, please keep the default value.



77
78
79
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 77

def exclude_unused_styles
  @exclude_unused_styles
end

#export_active_worksheet_only ⇒ Object

Indicates if exporting the whole workbook to html file.



93
94
95
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 93

def export_active_worksheet_only
  @export_active_worksheet_only
end

#export_bogus_row_data ⇒ Object

Indicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht file to excel, please keep the default value.



75
76
77
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 75

def export_bogus_row_data
  @export_bogus_row_data
end

#export_cell_coordinate ⇒ Object

Indicates whether exporting excel coordinate of nonblank cells when saving file to html. The default value is false. If you want to import the output html to excel, please keep the default value.



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

def export_cell_coordinate
  @export_cell_coordinate
end

#export_chart_image_format ⇒ Object

Get or set the format of chart image before exporting



95
96
97
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 95

def export_chart_image_format
  @export_chart_image_format
end

#export_document_properties ⇒ Object

Indicating whether exporting document properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.



79
80
81
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 79

def export_document_properties
  @export_document_properties
end

#export_extra_headings ⇒ Object

Indicates whether exporting extra headings when the length of text is longer than max display column. The default value is false. If you want to import the html file to excel, please keep the default value.



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

def export_extra_headings
  @export_extra_headings
end

#export_formula ⇒ Object

Indicates whether exporting formula when saving file to html. The default value is true. If you want to import the output html to excel, please keep the default value



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

def export_formula
  @export_formula
end

#export_frame_scripts_and_properties ⇒ Object

Indicating whether exporting frame scripts and document properties. The default value is true.If you want to import the html or mht file to excel, please keep the default value.



85
86
87
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 85

def export_frame_scripts_and_properties
  @export_frame_scripts_and_properties
end

#export_grid_lines ⇒ Object

Indicating whether exporting the gridlines.The default value is false.



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

def export_grid_lines
  @export_grid_lines
end

#export_headings ⇒ Object

Indicates whether exporting headings when saving file to html.The default value is false. If you want to import the html file to excel, please keep the default value.



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

def export_headings
  @export_headings
end

#export_hidden_worksheet ⇒ Object

Indicates whether save the html as single file. The default value is false.



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

def export_hidden_worksheet
  @export_hidden_worksheet
end

#export_images_as_base64 ⇒ Object

Returns the value of attribute export_images_as_base64.



97
98
99
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 97

def export_images_as_base64
  @export_images_as_base64
end

#export_page_footers ⇒ Object

Returns the value of attribute export_page_footers.



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

def export_page_footers
  @export_page_footers
end

#export_page_headers ⇒ Object

Returns the value of attribute export_page_headers.



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

def export_page_headers
  @export_page_headers
end

#export_row_column_headings ⇒ Object

Returns the value of attribute export_row_column_headings.



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

def export_row_column_headings
  @export_row_column_headings
end

#export_similar_border_style ⇒ Object

Returns the value of attribute export_similar_border_style.



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

def export_similar_border_style
  @export_similar_border_style
end

#export_workbook_properties ⇒ Object

Indicating whether exporting workbook properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.



83
84
85
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 83

def export_workbook_properties
  @export_workbook_properties
end

#export_worksheet_css_separately ⇒ Object

Indicating whether export the worksheet css separately.The default value is false.



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

def export_worksheet_css_separately
  @export_worksheet_css_separately
end

#export_worksheet_properties ⇒ Object

Indicating whether exporting worksheet properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.



81
82
83
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 81

def export_worksheet_properties
  @export_worksheet_properties
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”



99
100
101
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 99

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”



101
102
103
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 101

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.



103
104
105
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 103

def html_cross_string_type
  @html_cross_string_type
end

#image_options ⇒ Object

Returns the value of attribute image_options.



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

def image_options
  @image_options
end

#is_exp_image_to_temp_dir ⇒ Object

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



105
106
107
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 105

def is_exp_image_to_temp_dir
  @is_exp_image_to_temp_dir
end

#is_full_path_link ⇒ Object

Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.



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

def is_full_path_link
  @is_full_path_link
end

#merge_empty_td_forcely ⇒ Object

Indicates whether merging empty TD element forcely when exporting file to html. The size of html file will be reduced significantly after setting value to true. The default value is false. If you want to import the html file to excel or export perfect grid lines when saving file to html, please keep the default value.



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

def merge_empty_td_forcely
  @merge_empty_td_forcely
end

#page_title ⇒ Object

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



107
108
109
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 107

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



109
110
111
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 109

def parse_html_tag_in_cell
  @parse_html_tag_in_cell
end

#presentation_preference ⇒ Object

Indicating if html or mht file is presentation preference.The default value is false.if you want to get more beautiful presentation,please set the value to true.



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

def presentation_preference
  @presentation_preference
end

#refresh_chart_cache ⇒ Object

Returns the value of attribute refresh_chart_cache.



123
124
125
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 123

def refresh_chart_cache
  @refresh_chart_cache
end

#save_as_single_file ⇒ Object

Indicates whether save the html as single file. The default value is false.



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

def save_as_single_file
  @save_as_single_file
end

#save_format ⇒ Object

Returns the value of attribute save_format.



113
114
115
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 113

def save_format
  @save_format
end

#show_all_sheets ⇒ Object

Returns the value of attribute show_all_sheets.



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

def show_all_sheets
  @show_all_sheets
end

#sort_names ⇒ Object

Returns the value of attribute sort_names.



125
126
127
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 125

def sort_names
  @sort_names
end

#table_css_id ⇒ Object

Gets and sets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element which has the specific TableCssId attribute. The default value is “”.



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

def table_css_id
  @table_css_id
end

#validate_merged_areas ⇒ Object

Returns the value of attribute validate_merged_areas.



127
128
129
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 127

def validate_merged_areas
  @validate_merged_areas
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'export_page_headers' => :'ExportPageHeaders',
    :'export_page_footers' => :'ExportPageFooters',
    :'export_row_column_headings' => :'ExportRowColumnHeadings',
    :'show_all_sheets' => :'ShowAllSheets',
    :'image_options' => :'ImageOptions',
    :'save_as_single_file' => :'SaveAsSingleFile',
    :'export_hidden_worksheet' => :'ExportHiddenWorksheet',
    :'export_grid_lines' => :'ExportGridLines',
    :'presentation_preference' => :'PresentationPreference',
    :'cell_css_prefix' => :'CellCssPrefix',
    :'table_css_id' => :'TableCssId',
    :'is_full_path_link' => :'IsFullPathLink',
    :'export_worksheet_css_separately' => :'ExportWorksheetCSSSeparately',
    :'export_similar_border_style' => :'ExportSimilarBorderStyle',
    :'merge_empty_td_forcely' => :'MergeEmptyTdForcely',
    :'export_cell_coordinate' => :'ExportCellCoordinate',
    :'export_extra_headings' => :'ExportExtraHeadings',
    :'export_headings' => :'ExportHeadings',
    :'export_formula' => :'ExportFormula',
    :'add_tooltip_text' => :'AddTooltipText',
    :'export_bogus_row_data' => :'ExportBogusRowData',
    :'exclude_unused_styles' => :'ExcludeUnusedStyles',
    :'export_document_properties' => :'ExportDocumentProperties',
    :'export_worksheet_properties' => :'ExportWorksheetProperties',
    :'export_workbook_properties' => :'ExportWorkbookProperties',
    :'export_frame_scripts_and_properties' => :'ExportFrameScriptsAndProperties',
    :'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',
    :'cell_name_attribute' => :'CellNameAttribute',
    :'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.



183
184
185
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
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 183

def self.swagger_types
  {
    :'export_page_headers' => :'BOOLEAN',
    :'export_page_footers' => :'BOOLEAN',
    :'export_row_column_headings' => :'BOOLEAN',
    :'show_all_sheets' => :'BOOLEAN',
    :'image_options' => :'ImageOrPrintOptions',
    :'save_as_single_file' => :'BOOLEAN',
    :'export_hidden_worksheet' => :'BOOLEAN',
    :'export_grid_lines' => :'BOOLEAN',
    :'presentation_preference' => :'BOOLEAN',
    :'cell_css_prefix' => :'String',
    :'table_css_id' => :'String',
    :'is_full_path_link' => :'BOOLEAN',
    :'export_worksheet_css_separately' => :'BOOLEAN',
    :'export_similar_border_style' => :'BOOLEAN',
    :'merge_empty_td_forcely' => :'BOOLEAN',
    :'export_cell_coordinate' => :'BOOLEAN',
    :'export_extra_headings' => :'BOOLEAN',
    :'export_headings' => :'BOOLEAN',
    :'export_formula' => :'BOOLEAN',
    :'add_tooltip_text' => :'BOOLEAN',
    :'export_bogus_row_data' => :'BOOLEAN',
    :'exclude_unused_styles' => :'BOOLEAN',
    :'export_document_properties' => :'BOOLEAN',
    :'export_worksheet_properties' => :'BOOLEAN',
    :'export_workbook_properties' => :'BOOLEAN',
    :'export_frame_scripts_and_properties' => :'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',
    :'cell_name_attribute' => :'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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 591

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      export_page_headers == o.export_page_headers &&
      export_page_footers == o.export_page_footers &&
      export_row_column_headings == o.export_row_column_headings &&
      show_all_sheets == o.show_all_sheets &&
      image_options == o.image_options &&
      save_as_single_file == o.save_as_single_file &&
      export_hidden_worksheet == o.export_hidden_worksheet &&
      export_grid_lines == o.export_grid_lines &&
      presentation_preference == o.presentation_preference &&
      cell_css_prefix == o.cell_css_prefix &&
      table_css_id == o.table_css_id &&
      is_full_path_link == o.is_full_path_link &&
      export_worksheet_css_separately == o.export_worksheet_css_separately &&
      export_similar_border_style == o.export_similar_border_style &&
      merge_empty_td_forcely == o.merge_empty_td_forcely &&
      export_cell_coordinate == o.export_cell_coordinate &&
      export_extra_headings == o.export_extra_headings &&
      export_headings == o.export_headings &&
      export_formula == o.export_formula &&
      add_tooltip_text == o.add_tooltip_text &&
      export_bogus_row_data == o.export_bogus_row_data &&
      exclude_unused_styles == o.exclude_unused_styles &&
      export_document_properties == o.export_document_properties &&
      export_worksheet_properties == o.export_worksheet_properties &&
      export_workbook_properties == o.export_workbook_properties &&
      export_frame_scripts_and_properties == o.export_frame_scripts_and_properties &&
      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 &&
      cell_name_attribute == o.cell_name_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 
      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



680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 680

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



746
747
748
749
750
751
752
753
754
755
756
757
758
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 746

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



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 659

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


646
647
648
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 646

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



652
653
654
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 652

def hash
  [ export_page_headers , export_page_footers , export_row_column_headings , show_all_sheets , image_options , save_as_single_file , export_hidden_worksheet , export_grid_lines , presentation_preference , cell_css_prefix , table_css_id , is_full_path_link , export_worksheet_css_separately , export_similar_border_style , merge_empty_td_forcely , export_cell_coordinate , export_extra_headings , export_headings , export_formula , add_tooltip_text , export_bogus_row_data , exclude_unused_styles , export_document_properties , export_worksheet_properties , export_workbook_properties , export_frame_scripts_and_properties , 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 , cell_name_attribute , 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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 389

def list_invalid_properties
  invalid_properties = Array.new
  if @export_page_headers.nil?
      invalid_properties.push("invalid value for 'export_page_headers', export_page_headers cannot be nil.")
  end
  if @export_page_footers.nil?
      invalid_properties.push("invalid value for 'export_page_footers', export_page_footers cannot be nil.")
  end
  if @export_row_column_headings.nil?
      invalid_properties.push("invalid value for 'export_row_column_headings', export_row_column_headings cannot be nil.")
  end
  if @show_all_sheets.nil?
      invalid_properties.push("invalid value for 'show_all_sheets', show_all_sheets cannot be nil.")
  end
  if @image_options.nil?
      invalid_properties.push("invalid value for 'image_options', image_options cannot be nil.")
  end
  if @save_as_single_file.nil?
      invalid_properties.push("invalid value for 'save_as_single_file', save_as_single_file cannot be nil.")
  end
  if @export_hidden_worksheet.nil?
      invalid_properties.push("invalid value for 'export_hidden_worksheet', export_hidden_worksheet cannot be nil.")
  end
  if @export_grid_lines.nil?
      invalid_properties.push("invalid value for 'export_grid_lines', export_grid_lines cannot be nil.")
  end
  if @presentation_preference.nil?
      invalid_properties.push("invalid value for 'presentation_preference', presentation_preference cannot be nil.")
  end
  if @cell_css_prefix.nil?
      invalid_properties.push("invalid value for 'cell_css_prefix', cell_css_prefix cannot be nil.")
  end
  if @table_css_id.nil?
      invalid_properties.push("invalid value for 'table_css_id', table_css_id cannot be nil.")
  end
  if @is_full_path_link.nil?
      invalid_properties.push("invalid value for 'is_full_path_link', is_full_path_link cannot be nil.")
  end
  if @export_worksheet_css_separately.nil?
      invalid_properties.push("invalid value for 'export_worksheet_css_separately', export_worksheet_css_separately cannot be nil.")
  end
  if @export_similar_border_style.nil?
      invalid_properties.push("invalid value for 'export_similar_border_style', export_similar_border_style cannot be nil.")
  end
  if @merge_empty_td_forcely.nil?
      invalid_properties.push("invalid value for 'merge_empty_td_forcely', merge_empty_td_forcely cannot be nil.")
  end
  if @export_cell_coordinate.nil?
      invalid_properties.push("invalid value for 'export_cell_coordinate', export_cell_coordinate cannot be nil.")
  end
  if @export_extra_headings.nil?
      invalid_properties.push("invalid value for 'export_extra_headings', export_extra_headings cannot be nil.")
  end
  if @export_headings.nil?
      invalid_properties.push("invalid value for 'export_headings', export_headings cannot be nil.")
  end
  if @export_formula.nil?
      invalid_properties.push("invalid value for 'export_formula', export_formula cannot be nil.")
  end
  if @add_tooltip_text.nil?
      invalid_properties.push("invalid value for 'add_tooltip_text', add_tooltip_text cannot be nil.")
  end
  if @export_bogus_row_data.nil?
      invalid_properties.push("invalid value for 'export_bogus_row_data', export_bogus_row_data cannot be nil.")
  end
  if @exclude_unused_styles.nil?
      invalid_properties.push("invalid value for 'exclude_unused_styles', exclude_unused_styles cannot be nil.")
  end
  if @export_document_properties.nil?
      invalid_properties.push("invalid value for 'export_document_properties', export_document_properties cannot be nil.")
  end
  if @export_worksheet_properties.nil?
      invalid_properties.push("invalid value for 'export_worksheet_properties', export_worksheet_properties cannot be nil.")
  end
  if @export_workbook_properties.nil?
      invalid_properties.push("invalid value for 'export_workbook_properties', export_workbook_properties cannot be nil.")
  end
  if @export_frame_scripts_and_properties.nil?
      invalid_properties.push("invalid value for 'export_frame_scripts_and_properties', export_frame_scripts_and_properties cannot be nil.")
  end
  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 @cell_name_attribute.nil?
      invalid_properties.push("invalid value for 'cell_name_attribute', cell_name_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

  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



726
727
728
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 726

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



732
733
734
735
736
737
738
739
740
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 732

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



720
721
722
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 720

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



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'lib/aspose_cells_cloud/models/html_save_options.rb', line 538

def valid?
  return false if @export_page_headers.nil?
  return false if @export_page_footers.nil?
  return false if @export_row_column_headings.nil?
  return false if @show_all_sheets.nil?
  return false if @image_options.nil?
  return false if @save_as_single_file.nil?
  return false if @export_hidden_worksheet.nil?
  return false if @export_grid_lines.nil?
  return false if @presentation_preference.nil?
  return false if @cell_css_prefix.nil?
  return false if @table_css_id.nil?
  return false if @is_full_path_link.nil?
  return false if @export_worksheet_css_separately.nil?
  return false if @export_similar_border_style.nil?
  return false if @merge_empty_td_forcely.nil?
  return false if @export_cell_coordinate.nil?
  return false if @export_extra_headings.nil?
  return false if @export_headings.nil?
  return false if @export_formula.nil?
  return false if @add_tooltip_text.nil?
  return false if @export_bogus_row_data.nil?
  return false if @exclude_unused_styles.nil?
  return false if @export_document_properties.nil?
  return false if @export_worksheet_properties.nil?
  return false if @export_workbook_properties.nil?
  return false if @export_frame_scripts_and_properties.nil?
  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 @cell_name_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 true
end