Class: AsposeWordsCloud::MhtmlSaveOptionsData

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/mhtml_save_options_data.rb

Overview

Container class for mhtml save options.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MhtmlSaveOptionsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
386
387
388
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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 346

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 }

  self.save_format = 'mht'

  if attributes.key?(:'AllowEmbeddingPostScriptFonts')
    self.allow_embedding_post_script_fonts = attributes[:'AllowEmbeddingPostScriptFonts']
  end

  if attributes.key?(:'CustomTimeZoneInfoData')
    self.custom_time_zone_info_data = attributes[:'CustomTimeZoneInfoData']
  end

  if attributes.key?(:'Dml3DEffectsRenderingMode')
    self.dml3_d_effects_rendering_mode = attributes[:'Dml3DEffectsRenderingMode']
  end

  if attributes.key?(:'DmlEffectsRenderingMode')
    self.dml_effects_rendering_mode = attributes[:'DmlEffectsRenderingMode']
  end

  if attributes.key?(:'DmlRenderingMode')
    self.dml_rendering_mode = attributes[:'DmlRenderingMode']
  end

  if attributes.key?(:'FileName')
    self.file_name = attributes[:'FileName']
  end

  if attributes.key?(:'ImlRenderingMode')
    self.iml_rendering_mode = attributes[:'ImlRenderingMode']
  end

  if attributes.key?(:'UpdateCreatedTimeProperty')
    self.update_created_time_property = attributes[:'UpdateCreatedTimeProperty']
  end

  if attributes.key?(:'UpdateFields')
    self.update_fields = attributes[:'UpdateFields']
  end

  if attributes.key?(:'UpdateLastPrintedProperty')
    self.update_last_printed_property = attributes[:'UpdateLastPrintedProperty']
  end

  if attributes.key?(:'UpdateLastSavedTimeProperty')
    self.update_last_saved_time_property = attributes[:'UpdateLastSavedTimeProperty']
  end

  if attributes.key?(:'UpdateSdtContent')
    self.update_sdt_content = attributes[:'UpdateSdtContent']
  end

  if attributes.key?(:'ZipOutput')
    self.zip_output = attributes[:'ZipOutput']
  end

  if attributes.key?(:'AllowNegativeIndent')
    self.allow_negative_indent = attributes[:'AllowNegativeIndent']
  end

  if attributes.key?(:'CssClassNamePrefix')
    self.css_class_name_prefix = attributes[:'CssClassNamePrefix']
  end

  if attributes.key?(:'CssStyleSheetFileName')
    self.css_style_sheet_file_name = attributes[:'CssStyleSheetFileName']
  end

  if attributes.key?(:'CssStyleSheetType')
    self.css_style_sheet_type = attributes[:'CssStyleSheetType']
  end

  if attributes.key?(:'DocumentSplitCriteria')
    self.document_split_criteria = attributes[:'DocumentSplitCriteria']
  end

  if attributes.key?(:'DocumentSplitHeadingLevel')
    self.document_split_heading_level = attributes[:'DocumentSplitHeadingLevel']
  end

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

  if attributes.key?(:'ExportDocumentProperties')
    self.export_document_properties = attributes[:'ExportDocumentProperties']
  end

  if attributes.key?(:'ExportDropDownFormFieldAsText')
    self.export_drop_down_form_field_as_text = attributes[:'ExportDropDownFormFieldAsText']
  end

  if attributes.key?(:'ExportFontResources')
    self.export_font_resources = attributes[:'ExportFontResources']
  end

  if attributes.key?(:'ExportFontsAsBase64')
    self.export_fonts_as_base64 = attributes[:'ExportFontsAsBase64']
  end

  if attributes.key?(:'ExportHeadersFootersMode')
    self.export_headers_footers_mode = attributes[:'ExportHeadersFootersMode']
  end

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

  if attributes.key?(:'ExportLanguageInformation')
    self.export_language_information = attributes[:'ExportLanguageInformation']
  end

  if attributes.key?(:'ExportListLabels')
    self.export_list_labels = attributes[:'ExportListLabels']
  end

  if attributes.key?(:'ExportOriginalUrlForLinkedImages')
    self.export_original_url_for_linked_images = attributes[:'ExportOriginalUrlForLinkedImages']
  end

  if attributes.key?(:'ExportPageMargins')
    self.export_page_margins = attributes[:'ExportPageMargins']
  end

  if attributes.key?(:'ExportPageSetup')
    self.export_page_setup = attributes[:'ExportPageSetup']
  end

  if attributes.key?(:'ExportRelativeFontSize')
    self.export_relative_font_size = attributes[:'ExportRelativeFontSize']
  end

  if attributes.key?(:'ExportRoundtripInformation')
    self.export_roundtrip_information = attributes[:'ExportRoundtripInformation']
  end

  if attributes.key?(:'ExportTextInputFormFieldAsText')
    self.export_text_input_form_field_as_text = attributes[:'ExportTextInputFormFieldAsText']
  end

  if attributes.key?(:'ExportTocPageNumbers')
    self.export_toc_page_numbers = attributes[:'ExportTocPageNumbers']
  end

  if attributes.key?(:'ExportXhtmlTransitional')
    self.export_xhtml_transitional = attributes[:'ExportXhtmlTransitional']
  end

  if attributes.key?(:'FontResourcesSubsettingSizeThreshold')
    self.font_resources_subsetting_size_threshold = attributes[:'FontResourcesSubsettingSizeThreshold']
  end

  if attributes.key?(:'FontsFolder')
    self.fonts_folder = attributes[:'FontsFolder']
  end

  if attributes.key?(:'FontsFolderAlias')
    self.fonts_folder_alias = attributes[:'FontsFolderAlias']
  end

  if attributes.key?(:'HtmlVersion')
    self.html_version = attributes[:'HtmlVersion']
  end

  if attributes.key?(:'ImageResolution')
    self.image_resolution = attributes[:'ImageResolution']
  end

  if attributes.key?(:'ImagesFolder')
    self.images_folder = attributes[:'ImagesFolder']
  end

  if attributes.key?(:'ImagesFolderAlias')
    self.images_folder_alias = attributes[:'ImagesFolderAlias']
  end

  if attributes.key?(:'MetafileFormat')
    self.metafile_format = attributes[:'MetafileFormat']
  end

  if attributes.key?(:'OfficeMathOutputMode')
    self.office_math_output_mode = attributes[:'OfficeMathOutputMode']
  end

  if attributes.key?(:'PrettyFormat')
    self.pretty_format = attributes[:'PrettyFormat']
  end

  if attributes.key?(:'ResolveFontNames')
    self.resolve_font_names = attributes[:'ResolveFontNames']
  end

  if attributes.key?(:'ResourceFolder')
    self.resource_folder = attributes[:'ResourceFolder']
  end

  if attributes.key?(:'ResourceFolderAlias')
    self.resource_folder_alias = attributes[:'ResourceFolderAlias']
  end

  if attributes.key?(:'ScaleImageToShapeSize')
    self.scale_image_to_shape_size = attributes[:'ScaleImageToShapeSize']
  end

  if attributes.key?(:'TableWidthOutputMode')
    self.table_width_output_mode = attributes[:'TableWidthOutputMode']
  end

  if attributes.key?(:'ExportCidUrlsForMhtmlResources')
    self.export_cid_urls_for_mhtml_resources = attributes[:'ExportCidUrlsForMhtmlResources']
  end
end

Instance Attribute Details

#allow_embedding_post_script_fonts ⇒ Object

Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false..



33
34
35
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 33

def allow_embedding_post_script_fonts
  @allow_embedding_post_script_fonts
end

#allow_negative_indent ⇒ Object

Gets or sets a value indicating whether negative left and right indents of paragraphs are allowed (not normalized).



75
76
77
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 75

def allow_negative_indent
  @allow_negative_indent
end

#css_class_name_prefix ⇒ Object

Gets or sets the prefix which is added to all CSS class names. The default value is an empty string and generated CSS class names have no common prefix. If this value is not empty, all CSS classes generated by Aspose.Words will start with the specified prefix.This might be useful, for example, if you add custom CSS to generated documents and want to prevent class name conflicts. If the value is not null or empty, it must be a valid CSS identifier.



80
81
82
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 80

def css_class_name_prefix
  @css_class_name_prefix
end

#css_style_sheet_file_name ⇒ Object

Gets or sets the name of the CSS file written when the document is exported to HTML.



83
84
85
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 83

def css_style_sheet_file_name
  @css_style_sheet_file_name
end

#css_style_sheet_type ⇒ Object

Gets or sets the option that controls how the CSS styles are exported.



86
87
88
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 86

def css_style_sheet_type
  @css_style_sheet_type
end

#custom_time_zone_info_data ⇒ Object

Gets or sets CustomTimeZoneInfo.



36
37
38
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 36

def custom_time_zone_info_data
  @custom_time_zone_info_data
end

#dml3_d_effects_rendering_mode ⇒ Object

Gets or sets the value determining how 3D effects are rendered.



39
40
41
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 39

def dml3_d_effects_rendering_mode
  @dml3_d_effects_rendering_mode
end

#dml_effects_rendering_mode ⇒ Object

Gets or sets the value determining how DrawingML effects are rendered. { Simplified | None | Fine }.



43
44
45
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 43

def dml_effects_rendering_mode
  @dml_effects_rendering_mode
end

#dml_rendering_mode ⇒ Object

Gets or sets the option that controls how DrawingML shapes are rendered.



46
47
48
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 46

def dml_rendering_mode
  @dml_rendering_mode
end

#document_split_criteria ⇒ Object

Gets or sets the option that controls how the document should be split when saving.



89
90
91
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 89

def document_split_criteria
  @document_split_criteria
end

#document_split_heading_level ⇒ Object

Gets or sets the maximum level of headings at which to split the document.



92
93
94
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 92

def document_split_heading_level
  @document_split_heading_level
end

#encoding ⇒ Object

Gets or sets the character encoding to use when exporting.



95
96
97
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 95

def encoding
  @encoding
end

#export_cid_urls_for_mhtml_resources ⇒ Object

Gets or sets a value indicating whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. The default value is false.



199
200
201
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 199

def export_cid_urls_for_mhtml_resources
  @export_cid_urls_for_mhtml_resources
end

#export_document_properties ⇒ Object

Gets or sets a value indicating whether to export built-in and custom document properties.



98
99
100
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 98

def export_document_properties
  @export_document_properties
end

#export_drop_down_form_field_as_text ⇒ Object

Gets or sets the flag, that controls how drop-down form fields are saved to HTML. The default value is false.



102
103
104
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 102

def export_drop_down_form_field_as_text
  @export_drop_down_form_field_as_text
end

#export_font_resources ⇒ Object

Gets or sets a value indicating whether font resources should be exported.



105
106
107
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 105

def export_font_resources
  @export_font_resources
end

#export_fonts_as_base64 ⇒ Object

Gets or sets a value indicating whether fonts resources should be embedded to HTML in Base64 encoding. The default value is false.



108
109
110
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 108

def export_fonts_as_base64
  @export_fonts_as_base64
end

#export_headers_footers_mode ⇒ Object

Gets or sets the option that controls how headers and footers are exported.



111
112
113
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 111

def export_headers_footers_mode
  @export_headers_footers_mode
end

#export_images_as_base64 ⇒ Object

Gets or sets a value indicating whether images are saved in Base64 format.



114
115
116
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 114

def export_images_as_base64
  @export_images_as_base64
end

#export_language_information ⇒ Object

Gets or sets a value indicating whether language information is exported.



117
118
119
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 117

def export_language_information
  @export_language_information
end

#export_list_labels ⇒ Object

Gets or sets the option that controls how list labels are exported.



120
121
122
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 120

def export_list_labels
  @export_list_labels
end

#export_original_url_for_linked_images ⇒ Object

Gets or sets a value indicating whether the original URL should be used as the URL of the linked images. The default value is false.



124
125
126
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 124

def export_original_url_for_linked_images
  @export_original_url_for_linked_images
end

#export_page_margins ⇒ Object

Gets or sets a value indicating whether page margins are exported to HTML, MHTML or EPUB. The default value is false.



128
129
130
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 128

def export_page_margins
  @export_page_margins
end

#export_page_setup ⇒ Object

Gets or sets a value indicating whether page setup is exported.



131
132
133
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 131

def export_page_setup
  @export_page_setup
end

#export_relative_font_size ⇒ Object

Gets or sets a value indicating whether font sizes should be output in relative units when saving.



134
135
136
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 134

def export_relative_font_size
  @export_relative_font_size
end

#export_roundtrip_information ⇒ Object

Gets or sets a value indicating whether to write the roundtrip information when saving to HTML. The default value is true.



137
138
139
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 137

def export_roundtrip_information
  @export_roundtrip_information
end

#export_text_input_form_field_as_text ⇒ Object

Gets or sets the flag, that controls how text input form fields are saved.



140
141
142
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 140

def export_text_input_form_field_as_text
  @export_text_input_form_field_as_text
end

#export_toc_page_numbers ⇒ Object

Gets or sets a value indicating whether to write page numbers to table of contents when saving.



143
144
145
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 143

def export_toc_page_numbers
  @export_toc_page_numbers
end

#export_xhtml_transitional ⇒ Object

Gets or sets a value indicating whether to write the DOCTYPE declaration when saving.



146
147
148
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 146

def export_xhtml_transitional
  @export_xhtml_transitional
end

#file_name ⇒ Object

Gets or sets the name of destination file.



49
50
51
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 49

def file_name
  @file_name
end

#font_resources_subsetting_size_threshold ⇒ Object

Gets or sets the option that controls which font resources need subsetting when saving.



149
150
151
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 149

def font_resources_subsetting_size_threshold
  @font_resources_subsetting_size_threshold
end

#fonts_folder ⇒ Object

Gets or sets the physical folder where fonts are saved when exporting a document.



152
153
154
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 152

def fonts_folder
  @fonts_folder
end

#fonts_folder_alias ⇒ Object

Gets or sets the name of the folder used to construct font URIs.



155
156
157
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 155

def fonts_folder_alias
  @fonts_folder_alias
end

#html_version ⇒ Object

Gets or sets the version of HTML standard, that should be used when saving the document to HTML or MHTML. Default value is Aspose.Words.Saving.HtmlVersion.Xhtml.



159
160
161
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 159

def html_version
  @html_version
end

#image_resolution ⇒ Object

Gets or sets the output resolution for images when exporting.



162
163
164
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 162

def image_resolution
  @image_resolution
end

#images_folder ⇒ Object

Gets or sets the physical folder where images are saved when exporting a document.



165
166
167
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 165

def images_folder
  @images_folder
end

#images_folder_alias ⇒ Object

Gets or sets the name of the folder used to construct image URIs.



168
169
170
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 168

def images_folder_alias
  @images_folder_alias
end

#iml_rendering_mode ⇒ Object

Gets or sets the value determining how ink (InkML) objects are rendered.



52
53
54
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 52

def iml_rendering_mode
  @iml_rendering_mode
end

#metafile_format ⇒ Object

Gets or sets the options, that controls in what format metafiles are saved when exporting to HTML, MHTML, or EPUB. The default value is Aspose.Words.Saving.HtmlMetafileFormat.Png, meaning that metafiles are rendered to raster PNG images. Metafiles are not natively displayed by HTML browsers. By default, Aspose.Words converts WMF and EMF images into PNG files when exporting to HTML.Other options are to convert metafiles to SVG images or to export them as is without conversion. Some image transforms, in particular image cropping, will not be applied to metafile images if they are exported to HTML without conversion.



174
175
176
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 174

def metafile_format
  @metafile_format
end

#office_math_output_mode ⇒ Object

Gets or sets the option that controls how OfficeMath objects are exported to HTML, MHTML or EPUB. The default value is HtmlOfficeMathOutputMode.Image.



177
178
179
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 177

def office_math_output_mode
  @office_math_output_mode
end

#pretty_format ⇒ Object

Gets or sets a value indicating whether to use pretty formats output.



180
181
182
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 180

def pretty_format
  @pretty_format
end

#resolve_font_names ⇒ Object

Gets or sets a value indicating whether font family names used in the document are resolved and substituted according to FontSettings when being written into HTML-based formats. The default value is false.



184
185
186
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 184

def resolve_font_names
  @resolve_font_names
end

#resource_folder ⇒ Object

Gets or sets the physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML. The default value is an empty string.



187
188
189
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 187

def resource_folder
  @resource_folder
end

#resource_folder_alias ⇒ Object

Gets or sets the name of the folder used to construct URIs of all resources written into HTML document. The default value is an empty string.



190
191
192
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 190

def resource_folder_alias
  @resource_folder_alias
end

#save_format ⇒ Object

Gets the format of save.



202
203
204
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 202

def save_format
  @save_format
end

#scale_image_to_shape_size ⇒ Object

Gets or sets a value indicating whether images are scaled by Aspose.Words to the bounding shape size when exporting.



193
194
195
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 193

def scale_image_to_shape_size
  @scale_image_to_shape_size
end

#table_width_output_mode ⇒ Object

Gets or sets the option that controls how table, row and cell widths are exported.



196
197
198
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 196

def table_width_output_mode
  @table_width_output_mode
end

#update_created_time_property ⇒ Object

Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving. Default value is false.



56
57
58
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 56

def update_created_time_property
  @update_created_time_property
end

#update_fields ⇒ Object

Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.



59
60
61
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 59

def update_fields
  @update_fields
end

#update_last_printed_property ⇒ Object

Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.



62
63
64
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 62

def update_last_printed_property
  @update_last_printed_property
end

#update_last_saved_time_property ⇒ Object

Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.



65
66
67
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 65

def update_last_saved_time_property
  @update_last_saved_time_property
end

#update_sdt_content ⇒ Object

Gets or sets a value indicating whether content of StructuredDocumentTag is updated before saving.



68
69
70
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 68

def update_sdt_content
  @update_sdt_content
end

#zip_output ⇒ Object

Gets or sets a value indicating whether to zip output or not. The default value is false.



72
73
74
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 72

def zip_output
  @zip_output
end

Class Method Details

.attribute_map ⇒ Object

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



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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 227

def self.attribute_map
  {
    :'allow_embedding_post_script_fonts' => :'AllowEmbeddingPostScriptFonts',
    :'custom_time_zone_info_data' => :'CustomTimeZoneInfoData',
    :'dml3_d_effects_rendering_mode' => :'Dml3DEffectsRenderingMode',
    :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode',
    :'dml_rendering_mode' => :'DmlRenderingMode',
    :'file_name' => :'FileName',
    :'iml_rendering_mode' => :'ImlRenderingMode',
    :'update_created_time_property' => :'UpdateCreatedTimeProperty',
    :'update_fields' => :'UpdateFields',
    :'update_last_printed_property' => :'UpdateLastPrintedProperty',
    :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty',
    :'update_sdt_content' => :'UpdateSdtContent',
    :'zip_output' => :'ZipOutput',
    :'allow_negative_indent' => :'AllowNegativeIndent',
    :'css_class_name_prefix' => :'CssClassNamePrefix',
    :'css_style_sheet_file_name' => :'CssStyleSheetFileName',
    :'css_style_sheet_type' => :'CssStyleSheetType',
    :'document_split_criteria' => :'DocumentSplitCriteria',
    :'document_split_heading_level' => :'DocumentSplitHeadingLevel',
    :'encoding' => :'Encoding',
    :'export_document_properties' => :'ExportDocumentProperties',
    :'export_drop_down_form_field_as_text' => :'ExportDropDownFormFieldAsText',
    :'export_font_resources' => :'ExportFontResources',
    :'export_fonts_as_base64' => :'ExportFontsAsBase64',
    :'export_headers_footers_mode' => :'ExportHeadersFootersMode',
    :'export_images_as_base64' => :'ExportImagesAsBase64',
    :'export_language_information' => :'ExportLanguageInformation',
    :'export_list_labels' => :'ExportListLabels',
    :'export_original_url_for_linked_images' => :'ExportOriginalUrlForLinkedImages',
    :'export_page_margins' => :'ExportPageMargins',
    :'export_page_setup' => :'ExportPageSetup',
    :'export_relative_font_size' => :'ExportRelativeFontSize',
    :'export_roundtrip_information' => :'ExportRoundtripInformation',
    :'export_text_input_form_field_as_text' => :'ExportTextInputFormFieldAsText',
    :'export_toc_page_numbers' => :'ExportTocPageNumbers',
    :'export_xhtml_transitional' => :'ExportXhtmlTransitional',
    :'font_resources_subsetting_size_threshold' => :'FontResourcesSubsettingSizeThreshold',
    :'fonts_folder' => :'FontsFolder',
    :'fonts_folder_alias' => :'FontsFolderAlias',
    :'html_version' => :'HtmlVersion',
    :'image_resolution' => :'ImageResolution',
    :'images_folder' => :'ImagesFolder',
    :'images_folder_alias' => :'ImagesFolderAlias',
    :'metafile_format' => :'MetafileFormat',
    :'office_math_output_mode' => :'OfficeMathOutputMode',
    :'pretty_format' => :'PrettyFormat',
    :'resolve_font_names' => :'ResolveFontNames',
    :'resource_folder' => :'ResourceFolder',
    :'resource_folder_alias' => :'ResourceFolderAlias',
    :'scale_image_to_shape_size' => :'ScaleImageToShapeSize',
    :'table_width_output_mode' => :'TableWidthOutputMode',
    :'export_cid_urls_for_mhtml_resources' => :'ExportCidUrlsForMhtmlResources',
    :'save_format' => :'SaveFormat'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 286

def self.swagger_types
  {
    :'allow_embedding_post_script_fonts' => :'BOOLEAN',
    :'custom_time_zone_info_data' => :'TimeZoneInfoData',
    :'dml3_d_effects_rendering_mode' => :'String',
    :'dml_effects_rendering_mode' => :'String',
    :'dml_rendering_mode' => :'String',
    :'file_name' => :'String',
    :'iml_rendering_mode' => :'String',
    :'update_created_time_property' => :'BOOLEAN',
    :'update_fields' => :'BOOLEAN',
    :'update_last_printed_property' => :'BOOLEAN',
    :'update_last_saved_time_property' => :'BOOLEAN',
    :'update_sdt_content' => :'BOOLEAN',
    :'zip_output' => :'BOOLEAN',
    :'allow_negative_indent' => :'BOOLEAN',
    :'css_class_name_prefix' => :'String',
    :'css_style_sheet_file_name' => :'String',
    :'css_style_sheet_type' => :'String',
    :'document_split_criteria' => :'String',
    :'document_split_heading_level' => :'Integer',
    :'encoding' => :'String',
    :'export_document_properties' => :'BOOLEAN',
    :'export_drop_down_form_field_as_text' => :'BOOLEAN',
    :'export_font_resources' => :'BOOLEAN',
    :'export_fonts_as_base64' => :'BOOLEAN',
    :'export_headers_footers_mode' => :'String',
    :'export_images_as_base64' => :'BOOLEAN',
    :'export_language_information' => :'BOOLEAN',
    :'export_list_labels' => :'String',
    :'export_original_url_for_linked_images' => :'BOOLEAN',
    :'export_page_margins' => :'BOOLEAN',
    :'export_page_setup' => :'BOOLEAN',
    :'export_relative_font_size' => :'BOOLEAN',
    :'export_roundtrip_information' => :'BOOLEAN',
    :'export_text_input_form_field_as_text' => :'BOOLEAN',
    :'export_toc_page_numbers' => :'BOOLEAN',
    :'export_xhtml_transitional' => :'BOOLEAN',
    :'font_resources_subsetting_size_threshold' => :'Integer',
    :'fonts_folder' => :'String',
    :'fonts_folder_alias' => :'String',
    :'html_version' => :'String',
    :'image_resolution' => :'Integer',
    :'images_folder' => :'String',
    :'images_folder_alias' => :'String',
    :'metafile_format' => :'String',
    :'office_math_output_mode' => :'String',
    :'pretty_format' => :'BOOLEAN',
    :'resolve_font_names' => :'BOOLEAN',
    :'resource_folder' => :'String',
    :'resource_folder_alias' => :'String',
    :'scale_image_to_shape_size' => :'BOOLEAN',
    :'table_width_output_mode' => :'String',
    :'export_cid_urls_for_mhtml_resources' => :'BOOLEAN',
    :'save_format' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 772

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      allow_embedding_post_script_fonts == other.allow_embedding_post_script_fonts &&
      custom_time_zone_info_data == other.custom_time_zone_info_data &&
      dml3_d_effects_rendering_mode == other.dml3_d_effects_rendering_mode &&
      dml_effects_rendering_mode == other.dml_effects_rendering_mode &&
      dml_rendering_mode == other.dml_rendering_mode &&
      file_name == other.file_name &&
      iml_rendering_mode == other.iml_rendering_mode &&
      update_created_time_property == other.update_created_time_property &&
      update_fields == other.update_fields &&
      update_last_printed_property == other.update_last_printed_property &&
      update_last_saved_time_property == other.update_last_saved_time_property &&
      update_sdt_content == other.update_sdt_content &&
      zip_output == other.zip_output &&
      allow_negative_indent == other.allow_negative_indent &&
      css_class_name_prefix == other.css_class_name_prefix &&
      css_style_sheet_file_name == other.css_style_sheet_file_name &&
      css_style_sheet_type == other.css_style_sheet_type &&
      document_split_criteria == other.document_split_criteria &&
      document_split_heading_level == other.document_split_heading_level &&
      encoding == other.encoding &&
      export_document_properties == other.export_document_properties &&
      export_drop_down_form_field_as_text == other.export_drop_down_form_field_as_text &&
      export_font_resources == other.export_font_resources &&
      export_fonts_as_base64 == other.export_fonts_as_base64 &&
      export_headers_footers_mode == other.export_headers_footers_mode &&
      export_images_as_base64 == other.export_images_as_base64 &&
      export_language_information == other.export_language_information &&
      export_list_labels == other.export_list_labels &&
      export_original_url_for_linked_images == other.export_original_url_for_linked_images &&
      export_page_margins == other.export_page_margins &&
      export_page_setup == other.export_page_setup &&
      export_relative_font_size == other.export_relative_font_size &&
      export_roundtrip_information == other.export_roundtrip_information &&
      export_text_input_form_field_as_text == other.export_text_input_form_field_as_text &&
      export_toc_page_numbers == other.export_toc_page_numbers &&
      export_xhtml_transitional == other.export_xhtml_transitional &&
      font_resources_subsetting_size_threshold == other.font_resources_subsetting_size_threshold &&
      fonts_folder == other.fonts_folder &&
      fonts_folder_alias == other.fonts_folder_alias &&
      html_version == other.html_version &&
      image_resolution == other.image_resolution &&
      images_folder == other.images_folder &&
      images_folder_alias == other.images_folder_alias &&
      metafile_format == other.metafile_format &&
      office_math_output_mode == other.office_math_output_mode &&
      pretty_format == other.pretty_format &&
      resolve_font_names == other.resolve_font_names &&
      resource_folder == other.resource_folder &&
      resource_folder_alias == other.resource_folder_alias &&
      scale_image_to_shape_size == other.scale_image_to_shape_size &&
      table_width_output_mode == other.table_width_output_mode &&
      export_cid_urls_for_mhtml_resources == other.export_cid_urls_for_mhtml_resources &&
      save_format == other.save_format
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



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 867

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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 = AsposeWordsCloud.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



934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 934

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



845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 845

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

#collectFilesContent(resultFilesContent) ⇒ Object 



948
949
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 948

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


832
833
834
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 832

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



838
839
840
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 838

def hash
  [allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, update_sdt_content, zip_output, allow_negative_indent, css_class_name_prefix, css_style_sheet_file_name, css_style_sheet_type, document_split_criteria, document_split_heading_level, encoding, export_document_properties, export_drop_down_form_field_as_text, export_font_resources, export_fonts_as_base64, export_headers_footers_mode, export_images_as_base64, export_language_information, export_list_labels, export_original_url_for_linked_images, export_page_margins, export_page_setup, export_relative_font_size, export_roundtrip_information, export_text_input_form_field_as_text, export_toc_page_numbers, export_xhtml_transitional, font_resources_subsetting_size_threshold, fonts_folder, fonts_folder_alias, html_version, image_resolution, images_folder, images_folder_alias, metafile_format, office_math_output_mode, pretty_format, resolve_font_names, resource_folder, resource_folder_alias, scale_image_to_shape_size, table_width_output_mode, export_cid_urls_for_mhtml_resources, save_format].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



565
566
567
568
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 565

def list_invalid_properties
  invalid_properties = []
  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



914
915
916
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 914

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



920
921
922
923
924
925
926
927
928
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 920

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



908
909
910
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 908

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



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/aspose_words_cloud/models/mhtml_save_options_data.rb', line 572

def valid?
  dml3_d_effects_rendering_mode_validator = EnumAttributeValidator.new('String', ["Basic", "Advanced"])
  return false unless dml3_d_effects_rendering_mode_validator.valid?(@dml3_d_effects_rendering_mode)
  dml_effects_rendering_mode_validator = EnumAttributeValidator.new('String', ["Simplified", "None", "Fine"])
  return false unless dml_effects_rendering_mode_validator.valid?(@dml_effects_rendering_mode)
  dml_rendering_mode_validator = EnumAttributeValidator.new('String', ["Fallback", "DrawingML"])
  return false unless dml_rendering_mode_validator.valid?(@dml_rendering_mode)
  iml_rendering_mode_validator = EnumAttributeValidator.new('String', ["Fallback", "InkML"])
  return false unless iml_rendering_mode_validator.valid?(@iml_rendering_mode)
  css_style_sheet_type_validator = EnumAttributeValidator.new('String', ["Inline", "Embedded", "External"])
  return false unless css_style_sheet_type_validator.valid?(@css_style_sheet_type)
  document_split_criteria_validator = EnumAttributeValidator.new('String', ["None", "PageBreak", "ColumnBreak", "SectionBreak", "HeadingParagraph"])
  return false unless document_split_criteria_validator.valid?(@document_split_criteria)
  export_headers_footers_mode_validator = EnumAttributeValidator.new('String', ["None", "PerSection", "FirstSectionHeaderLastSectionFooter", "FirstPageHeaderFooterPerSection"])
  return false unless export_headers_footers_mode_validator.valid?(@export_headers_footers_mode)
  export_list_labels_validator = EnumAttributeValidator.new('String', ["Auto", "AsInlineText", "ByHtmlTags"])
  return false unless export_list_labels_validator.valid?(@export_list_labels)
  html_version_validator = EnumAttributeValidator.new('String', ["Xhtml", "Html5"])
  return false unless html_version_validator.valid?(@html_version)
  metafile_format_validator = EnumAttributeValidator.new('String', ["Png", "Svg", "EmfOrWmf"])
  return false unless metafile_format_validator.valid?(@metafile_format)
  office_math_output_mode_validator = EnumAttributeValidator.new('String', ["Image", "MathML", "Text"])
  return false unless office_math_output_mode_validator.valid?(@office_math_output_mode)
  table_width_output_mode_validator = EnumAttributeValidator.new('String', ["All", "RelativeOnly", "None"])
  return false unless table_width_output_mode_validator.valid?(@table_width_output_mode)

  return true
end