Class: AsposeWordsCloud::EpubSaveOptionsData

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

Overview

Container class for epub save options.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EpubSaveOptionsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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.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?(:'SaveFormat')
    self.save_format = attributes[:'SaveFormat']
  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?(:'ExportTextBoxAsSvg')
    self.export_text_box_as_svg = attributes[:'ExportTextBoxAsSvg']
  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?(:'EpubNavigationMapLevel')
    self.epub_navigation_map_level = attributes[:'EpubNavigationMapLevel']
  end
end

Instance Attribute Details

#allow_negative_indent ⇒ Object

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



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

def allow_negative_indent
  @allow_negative_indent
end

#css_class_name_prefix ⇒ Object

Gets or sets specifies a prefix which is added to all CSS class names. 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.



73
74
75
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 73

def css_class_name_prefix
  @css_class_name_prefix
end

#css_style_sheet_file_name ⇒ Object

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



76
77
78
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 76

def css_style_sheet_file_name
  @css_style_sheet_file_name
end

#css_style_sheet_type ⇒ Object

Gets or sets specifies how CSS styles are exported.



79
80
81
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 79

def css_style_sheet_type
  @css_style_sheet_type
end

#dml3_d_effects_rendering_mode ⇒ Object

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



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

def dml3_d_effects_rendering_mode
  @dml3_d_effects_rendering_mode
end

#dml_effects_rendering_mode ⇒ Object

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



37
38
39
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 37

def dml_effects_rendering_mode
  @dml_effects_rendering_mode
end

#dml_rendering_mode ⇒ Object

Gets or sets a value determining how DrawingML shapes are rendered. { Fallback | DrawingML }.



41
42
43
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 41

def dml_rendering_mode
  @dml_rendering_mode
end

#document_split_criteria ⇒ Object

Gets or sets specifies how the document should be split when saving.



82
83
84
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 82

def document_split_criteria
  @document_split_criteria
end

#document_split_heading_level ⇒ Object

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



85
86
87
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 85

def document_split_heading_level
  @document_split_heading_level
end

#encoding ⇒ Object

Gets or sets specifies the encoding to use when exporting.



88
89
90
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 88

def encoding
  @encoding
end

#epub_navigation_map_level ⇒ Object

Gets or sets specifies the maximum level of headings populated to the navigation map when exporting.



197
198
199
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 197

def epub_navigation_map_level
  @epub_navigation_map_level
end

#export_document_properties ⇒ Object

Gets or sets specifies whether to export built-in and custom document properties.



91
92
93
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 91

def export_document_properties
  @export_document_properties
end

#export_drop_down_form_field_as_text ⇒ Object

Gets or sets controls how drop-down form fields are saved to HTML. Default value is false.



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

def export_drop_down_form_field_as_text
  @export_drop_down_form_field_as_text
end

#export_font_resources ⇒ Object

Gets or sets specifies whether font resources should be exported.



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

def export_font_resources
  @export_font_resources
end

#export_fonts_as_base64 ⇒ Object

Gets or sets specifies whether fonts resources should be embedded to HTML in Base64 encoding. Default is false.



101
102
103
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 101

def export_fonts_as_base64
  @export_fonts_as_base64
end

#export_headers_footers_mode ⇒ Object

Gets or sets specifies how headers and footers are output.



104
105
106
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 104

def export_headers_footers_mode
  @export_headers_footers_mode
end

#export_images_as_base64 ⇒ Object

Gets or sets specifies whether images are saved in Base64 format.



107
108
109
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 107

def export_images_as_base64
  @export_images_as_base64
end

#export_language_information ⇒ Object

Gets or sets specifies whether language information is exported.



110
111
112
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 110

def export_language_information
  @export_language_information
end

#export_list_labels ⇒ Object

Gets or sets controls how list labels are output.



113
114
115
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 113

def export_list_labels
  @export_list_labels
end

#export_original_url_for_linked_images ⇒ Object

Gets or sets specifies whether original URL should be used as the URL of the linked images. Default value is false.



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

def export_original_url_for_linked_images
  @export_original_url_for_linked_images
end

#export_page_margins ⇒ Object

Gets or sets specifies whether page margins is exported to HTML, MHTML or EPUB. Default is false.



121
122
123
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 121

def export_page_margins
  @export_page_margins
end

#export_page_setup ⇒ Object

Gets or sets specifies whether page setup is exported.



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

def export_page_setup
  @export_page_setup
end

#export_relative_font_size ⇒ Object

Gets or sets specifies whether font sizes should be output in relative units when saving.



127
128
129
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 127

def export_relative_font_size
  @export_relative_font_size
end

#export_roundtrip_information ⇒ Object

Gets or sets specifies whether to write the roundtrip information when saving to HTML Default value is true.



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

def export_roundtrip_information
  @export_roundtrip_information
end

#export_text_box_as_svg ⇒ Object

Gets or sets controls how textboxes represented by Aspose.Words.Drawing.Shape are saved to HTML, MHTML or EPUB. Default value is false. When set to true, exports textboxes as inline “svg” elements. When false, exports as “image” elements.



135
136
137
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 135

def export_text_box_as_svg
  @export_text_box_as_svg
end

#export_text_input_form_field_as_text ⇒ Object

Gets or sets controls how text input form fields are saved.



138
139
140
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 138

def export_text_input_form_field_as_text
  @export_text_input_form_field_as_text
end

#export_toc_page_numbers ⇒ Object

Gets or sets specifies whether to write page numbers to table of contents when saving.



141
142
143
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 141

def export_toc_page_numbers
  @export_toc_page_numbers
end

#export_xhtml_transitional ⇒ Object

Gets or sets specifies whether to write the DOCTYPE declaration when saving.



144
145
146
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 144

def export_xhtml_transitional
  @export_xhtml_transitional
end

#file_name ⇒ Object

Gets or sets name of destination file.



44
45
46
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 44

def file_name
  @file_name
end

#font_resources_subsetting_size_threshold ⇒ Object

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



147
148
149
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 147

def font_resources_subsetting_size_threshold
  @font_resources_subsetting_size_threshold
end

#fonts_folder ⇒ Object

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



150
151
152
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 150

def fonts_folder
  @fonts_folder
end

#fonts_folder_alias ⇒ Object

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



153
154
155
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 153

def fonts_folder_alias
  @fonts_folder_alias
end

#html_version ⇒ Object

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



157
158
159
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 157

def html_version
  @html_version
end

#image_resolution ⇒ Object

Gets or sets specifies the output resolution for images when exporting.



160
161
162
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 160

def image_resolution
  @image_resolution
end

#images_folder ⇒ Object

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



163
164
165
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 163

def images_folder
  @images_folder
end

#images_folder_alias ⇒ Object

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



166
167
168
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 166

def images_folder_alias
  @images_folder_alias
end

#metafile_format ⇒ Object

Gets or sets specifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB. 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.



172
173
174
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 172

def metafile_format
  @metafile_format
end

#office_math_output_mode ⇒ Object

Gets or sets controls how OfficeMath objects are exported to HTML, MHTML or EPUB. Default value is HtmlOfficeMathOutputMode.Image.



175
176
177
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 175

def office_math_output_mode
  @office_math_output_mode
end

#pretty_format ⇒ Object

Gets or sets specifies whether or not use pretty formats output.



178
179
180
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 178

def pretty_format
  @pretty_format
end

#resolve_font_names ⇒ Object

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



182
183
184
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 182

def resolve_font_names
  @resolve_font_names
end

#resource_folder ⇒ Object

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



185
186
187
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 185

def resource_folder
  @resource_folder
end

#resource_folder_alias ⇒ Object

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



188
189
190
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 188

def resource_folder_alias
  @resource_folder_alias
end

#save_format ⇒ Object

Gets or sets format of save.



47
48
49
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 47

def save_format
  @save_format
end

#scale_image_to_shape_size ⇒ Object

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



191
192
193
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 191

def scale_image_to_shape_size
  @scale_image_to_shape_size
end

#table_width_output_mode ⇒ Object

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



194
195
196
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 194

def table_width_output_mode
  @table_width_output_mode
end

#update_fields ⇒ Object

Gets or sets a value determining if fields should be updated before saving the document to a fixed page format. Default value for this property is. true.



51
52
53
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 51

def update_fields
  @update_fields
end

#update_last_printed_property ⇒ Object

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



55
56
57
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 55

def update_last_printed_property
  @update_last_printed_property
end

#update_last_saved_time_property ⇒ Object

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



58
59
60
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 58

def update_last_saved_time_property
  @update_last_saved_time_property
end

#update_sdt_content ⇒ Object

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



61
62
63
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 61

def update_sdt_content
  @update_sdt_content
end

#zip_output ⇒ Object

Gets or sets controls zip output or not. Default value is false.



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

def zip_output
  @zip_output
end

Class Method Details

.attribute_map ⇒ Object

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



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
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 222

def self.attribute_map
  {
    :'dml3_d_effects_rendering_mode' => :'Dml3DEffectsRenderingMode',
    :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode',
    :'dml_rendering_mode' => :'DmlRenderingMode',
    :'file_name' => :'FileName',
    :'save_format' => :'SaveFormat',
    :'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_box_as_svg' => :'ExportTextBoxAsSvg',
    :'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',
    :'epub_navigation_map_level' => :'EpubNavigationMapLevel'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'dml3_d_effects_rendering_mode' => :'String',
    :'dml_effects_rendering_mode' => :'String',
    :'dml_rendering_mode' => :'String',
    :'file_name' => :'String',
    :'save_format' => :'String',
    :'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_box_as_svg' => :'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',
    :'epub_navigation_map_level' => :'Integer'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 623

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      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 &&
      save_format == other.save_format &&
      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_box_as_svg == other.export_text_box_as_svg &&
      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 &&
      epub_navigation_map_level == other.epub_navigation_map_level
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



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 715

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



782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 782

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



693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 693

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?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


680
681
682
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 680

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



686
687
688
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 686

def hash
  [dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, save_format, 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_box_as_svg, 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, epub_navigation_map_level].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



544
545
546
547
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 544

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



762
763
764
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 762

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



768
769
770
771
772
773
774
775
776
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 768

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



756
757
758
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 756

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



551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/aspose_words_cloud/models/epub_save_options_data.rb', line 551

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

  return true
end