Class: AsposeWordsCloud::HtmlFixedSaveOptionsData

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

Overview

Container class for fixed html save options.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HtmlFixedSaveOptionsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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 = 'htmlfixed'

  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?(:'UpdateAmbiguousTextFont')
    self.update_ambiguous_text_font = attributes[:'UpdateAmbiguousTextFont']
  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?(:'ZipOutput')
    self.zip_output = attributes[:'ZipOutput']
  end

  if attributes.key?(:'ColorMode')
    self.color_mode = attributes[:'ColorMode']
  end

  if attributes.key?(:'JpegQuality')
    self.jpeg_quality = attributes[:'JpegQuality']
  end

  if attributes.key?(:'MetafileRenderingOptions')
    self.metafile_rendering_options = attributes[:'MetafileRenderingOptions']
  end

  if attributes.key?(:'NumeralFormat')
    self.numeral_format = attributes[:'NumeralFormat']
  end

  if attributes.key?(:'OptimizeOutput')
    self.optimize_output = attributes[:'OptimizeOutput']
  end

  if attributes.key?(:'PageCount')
    self.page_count = attributes[:'PageCount']
  end

  if attributes.key?(:'PageIndex')
    self.page_index = attributes[:'PageIndex']
  end

  if attributes.key?(:'CssClassNamesPrefix')
    self.css_class_names_prefix = attributes[:'CssClassNamesPrefix']
  end

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

  if attributes.key?(:'ExportEmbeddedCss')
    self.export_embedded_css = attributes[:'ExportEmbeddedCss']
  end

  if attributes.key?(:'ExportEmbeddedFonts')
    self.export_embedded_fonts = attributes[:'ExportEmbeddedFonts']
  end

  if attributes.key?(:'ExportEmbeddedImages')
    self.export_embedded_images = attributes[:'ExportEmbeddedImages']
  end

  if attributes.key?(:'ExportFormFields')
    self.export_form_fields = attributes[:'ExportFormFields']
  end

  if attributes.key?(:'FontFormat')
    self.font_format = attributes[:'FontFormat']
  end

  if attributes.key?(:'IdPrefix')
    self.id_prefix = attributes[:'IdPrefix']
  end

  if attributes.key?(:'PageHorizontalAlignment')
    self.page_horizontal_alignment = attributes[:'PageHorizontalAlignment']
  end

  if attributes.key?(:'PageMargins')
    self.page_margins = attributes[:'PageMargins']
  end

  if attributes.key?(:'ResourcesFolder')
    self.resources_folder = attributes[:'ResourcesFolder']
  end

  if attributes.key?(:'ResourcesFolderAlias')
    self.resources_folder_alias = attributes[:'ResourcesFolderAlias']
  end

  if attributes.key?(:'SaveFontFaceCssSeparately')
    self.save_font_face_css_separately = attributes[:'SaveFontFaceCssSeparately']
  end

  if attributes.key?(:'ShowPageBorder')
    self.show_page_border = attributes[:'ShowPageBorder']
  end

  if attributes.key?(:'UseTargetMachineFonts')
    self.use_target_machine_fonts = attributes[:'UseTargetMachineFonts']
  end
end

Instance Attribute Details

#allow_embedding_post_script_fontsObject

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.. Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type. This option only works when Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts of the Aspose.Words.DocumentBase.FontInfos property is set to true. The default value is false.



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

def allow_embedding_post_script_fonts
  @allow_embedding_post_script_fonts
end

#color_modeObject

Gets or sets the value determining how colors are rendered. { Normal | Grayscale}. The default value is Normal. This property is used when the document is exported to fixed page formats.



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

def color_mode
  @color_mode
end

#css_class_names_prefixObject

Gets or sets the prefix which is added to all class names in style.css file. Default value is “aw”.



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

def css_class_names_prefix
  @css_class_names_prefix
end

#custom_time_zone_info_dataObject

Gets or sets CustomTimeZoneInfo.



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

def custom_time_zone_info_data
  @custom_time_zone_info_data
end

#dml3_d_effects_rendering_modeObject

Gets or sets the value determining how 3D effects are rendered. The default value is Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic.



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

def dml3_d_effects_rendering_mode
  @dml3_d_effects_rendering_mode
end

#dml_effects_rendering_modeObject

Gets or sets the value determining how DrawingML effects are rendered. { Simplified | None | Fine }. The default value is Simplified. This property is used when the document is exported to fixed page formats.



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

def dml_effects_rendering_mode
  @dml_effects_rendering_mode
end

#dml_rendering_modeObject

Gets or sets the option that controls how DrawingML shapes are rendered. { Fallback | DrawingML }. The default value is Fallback. This property is used when the document is exported to fixed page formats.



54
55
56
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 54

def dml_rendering_mode
  @dml_rendering_mode
end

#encodingObject

Gets or sets the character encoding.



116
117
118
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 116

def encoding
  @encoding
end

#export_embedded_cssObject

Gets or sets a value indicating whether the CSS (Cascading Style Sheet) should be embedded into the Html document.



119
120
121
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 119

def export_embedded_css
  @export_embedded_css
end

#export_embedded_fontsObject

Gets or sets a value indicating whether fonts should be embedded into the Html document in Base64 format.



122
123
124
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 122

def export_embedded_fonts
  @export_embedded_fonts
end

#export_embedded_imagesObject

Gets or sets a value indicating whether images should be embedded into the Html document in Base64 format.



125
126
127
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 125

def export_embedded_images
  @export_embedded_images
end

#export_form_fieldsObject

Gets or sets a value indicating whether form fields are exported as interactive items (as ‘input’ tag) rather than converted to text or graphics.



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

def export_form_fields
  @export_form_fields
end

#file_nameObject

Gets or sets the name of destination file.



57
58
59
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 57

def file_name
  @file_name
end

#font_formatObject

Gets or sets the export format of fonts.



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

def font_format
  @font_format
end

#id_prefixObject

Gets or sets a prefix that is prepended to all generated element IDs in the output document. Default value is null and no prefix is prepended. If the prefix is specified, it can contain only letters, digits, underscores, and hyphens, and must start with a letter.



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

def id_prefix
  @id_prefix
end

#iml_rendering_modeObject

Gets or sets the value determining how ink (InkML) objects are rendered. The default value is Aspose.Words.Saving.ImlRenderingMode.InkML.



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

def iml_rendering_mode
  @iml_rendering_mode
end

#jpeg_qualityObject

Gets or sets the quality of the JPEG images inside PDF document.



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

def jpeg_quality
  @jpeg_quality
end

#metafile_rendering_optionsObject

Gets or sets the metafile rendering options.



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

def metafile_rendering_options
  @metafile_rendering_options
end

#numeral_formatObject

Gets or sets the symbol set, that is used to represent numbers while rendering to fixed page formats.



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

def numeral_format
  @numeral_format
end

#optimize_outputObject

Gets or sets a value indicating whether it is required to optimize output of XPS. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true.. The default value is false.



103
104
105
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 103

def optimize_output
  @optimize_output
end

#page_countObject

Gets or sets the number of pages to render.



106
107
108
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 106

def page_count
  @page_count
end

#page_horizontal_alignmentObject

Gets or sets the horizontal alignment of pages in the HTML document. The default value is HtmlFixedHorizontalPageAlignment.Center.



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

def page_horizontal_alignment
  @page_horizontal_alignment
end

#page_indexObject

Gets or sets the 0-based index of the first page to render.



109
110
111
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 109

def page_index
  @page_index
end

#page_marginsObject

Gets or sets the margin around pages in HTML document. The margins value is measured in points and should be equal to or greater than 0. Default value is 10 points. Depends on the value of PageHorizontalAlignment property: Defines top, bottom and left page margins if the value is Left. Defines top, bottom and right page margins if the value is Right. Defines top and bottom page margins if the value is Center.



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

def page_margins
  @page_margins
end

#resources_folderObject

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



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

def resources_folder
  @resources_folder
end

#resources_folder_aliasObject

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



156
157
158
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 156

def resources_folder_alias
  @resources_folder_alias
end

#save_font_face_css_separatelyObject

Gets or sets a value indicating whether “@font-face” CSS rules should be placed into a separate file “fontFaces.css” when a document is being saved with external stylesheet (that is, when Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedCss is false). The default value is false, all CSS rules are written into single file “styles.css”. Setting this property to true restores the old behavior (separate files) for compatibility with legacy code.



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

def save_font_face_css_separately
  @save_font_face_css_separately
end

#save_formatObject

Gets the format of save.



169
170
171
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 169

def save_format
  @save_format
end

#show_page_borderObject

Gets or sets a value indicating whether to show border around pages.



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

def show_page_border
  @show_page_border
end

#update_ambiguous_text_fontObject

Gets or sets a value indicating whether the font attributes will be changed according to the character code being used.



64
65
66
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 64

def update_ambiguous_text_font
  @update_ambiguous_text_font
end

#update_created_time_propertyObject

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



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

def update_created_time_property
  @update_created_time_property
end

#update_fieldsObject

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.



71
72
73
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 71

def update_fields
  @update_fields
end

#update_last_printed_propertyObject

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



74
75
76
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 74

def update_last_printed_property
  @update_last_printed_property
end

#update_last_saved_time_propertyObject

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



78
79
80
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 78

def update_last_saved_time_property
  @update_last_saved_time_property
end

#use_target_machine_fontsObject

Gets or sets a value indicating whether fonts from target machine must be used to display the document. If this flag is set to true, Aspose.Words.Saving.HtmlFixedSaveOptions.FontFormat and Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedFonts properties do not have effect, also Aspose.Words.Saving.HtmlFixedSaveOptions.ResourceSavingCallback is not fired for fonts. The default value is false.



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

def use_target_machine_fonts
  @use_target_machine_fonts
end

#zip_outputObject

Gets or sets a value indicating whether to zip output or not. The default value is false. When set to true, output files will be zipped.



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

def zip_output
  @zip_output
end

Class Method Details

.attribute_mapObject

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



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_words_cloud/models/html_fixed_save_options_data.rb', line 194

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_ambiguous_text_font' => :'UpdateAmbiguousTextFont',
    :'update_created_time_property' => :'UpdateCreatedTimeProperty',
    :'update_fields' => :'UpdateFields',
    :'update_last_printed_property' => :'UpdateLastPrintedProperty',
    :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty',
    :'zip_output' => :'ZipOutput',
    :'color_mode' => :'ColorMode',
    :'jpeg_quality' => :'JpegQuality',
    :'metafile_rendering_options' => :'MetafileRenderingOptions',
    :'numeral_format' => :'NumeralFormat',
    :'optimize_output' => :'OptimizeOutput',
    :'page_count' => :'PageCount',
    :'page_index' => :'PageIndex',
    :'css_class_names_prefix' => :'CssClassNamesPrefix',
    :'encoding' => :'Encoding',
    :'export_embedded_css' => :'ExportEmbeddedCss',
    :'export_embedded_fonts' => :'ExportEmbeddedFonts',
    :'export_embedded_images' => :'ExportEmbeddedImages',
    :'export_form_fields' => :'ExportFormFields',
    :'font_format' => :'FontFormat',
    :'id_prefix' => :'IdPrefix',
    :'page_horizontal_alignment' => :'PageHorizontalAlignment',
    :'page_margins' => :'PageMargins',
    :'resources_folder' => :'ResourcesFolder',
    :'resources_folder_alias' => :'ResourcesFolderAlias',
    :'save_font_face_css_separately' => :'SaveFontFaceCssSeparately',
    :'show_page_border' => :'ShowPageBorder',
    :'use_target_machine_fonts' => :'UseTargetMachineFonts',
    :'save_format' => :'SaveFormat'
  }
end

.swagger_typesObject

Attribute type mapping.



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/html_fixed_save_options_data.rb', line 236

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_ambiguous_text_font' => :'BOOLEAN',
    :'update_created_time_property' => :'BOOLEAN',
    :'update_fields' => :'BOOLEAN',
    :'update_last_printed_property' => :'BOOLEAN',
    :'update_last_saved_time_property' => :'BOOLEAN',
    :'zip_output' => :'BOOLEAN',
    :'color_mode' => :'String',
    :'jpeg_quality' => :'Integer',
    :'metafile_rendering_options' => :'MetafileRenderingOptionsData',
    :'numeral_format' => :'String',
    :'optimize_output' => :'BOOLEAN',
    :'page_count' => :'Integer',
    :'page_index' => :'Integer',
    :'css_class_names_prefix' => :'String',
    :'encoding' => :'String',
    :'export_embedded_css' => :'BOOLEAN',
    :'export_embedded_fonts' => :'BOOLEAN',
    :'export_embedded_images' => :'BOOLEAN',
    :'export_form_fields' => :'BOOLEAN',
    :'font_format' => :'String',
    :'id_prefix' => :'String',
    :'page_horizontal_alignment' => :'String',
    :'page_margins' => :'Float',
    :'resources_folder' => :'String',
    :'resources_folder_alias' => :'String',
    :'save_font_face_css_separately' => :'BOOLEAN',
    :'show_page_border' => :'BOOLEAN',
    :'use_target_machine_fonts' => :'BOOLEAN',
    :'save_format' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



566
567
568
569
570
571
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
600
601
602
603
604
605
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 566

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_ambiguous_text_font == other.update_ambiguous_text_font &&
      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 &&
      zip_output == other.zip_output &&
      color_mode == other.color_mode &&
      jpeg_quality == other.jpeg_quality &&
      metafile_rendering_options == other.metafile_rendering_options &&
      numeral_format == other.numeral_format &&
      optimize_output == other.optimize_output &&
      page_count == other.page_count &&
      page_index == other.page_index &&
      css_class_names_prefix == other.css_class_names_prefix &&
      encoding == other.encoding &&
      export_embedded_css == other.export_embedded_css &&
      export_embedded_fonts == other.export_embedded_fonts &&
      export_embedded_images == other.export_embedded_images &&
      export_form_fields == other.export_form_fields &&
      font_format == other.font_format &&
      id_prefix == other.id_prefix &&
      page_horizontal_alignment == other.page_horizontal_alignment &&
      page_margins == other.page_margins &&
      resources_folder == other.resources_folder &&
      resources_folder_alias == other.resources_folder_alias &&
      save_font_face_css_separately == other.save_font_face_css_separately &&
      show_page_border == other.show_page_border &&
      use_target_machine_fonts == other.use_target_machine_fonts &&
      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



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
677
678
679
680
681
682
683
684
685
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 644

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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    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



715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 715

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



622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 622

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



729
730
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 729

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


609
610
611
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 609

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



615
616
617
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 615

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_ambiguous_text_font, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, css_class_names_prefix, encoding, export_embedded_css, export_embedded_fonts, export_embedded_images, export_form_fields, font_format, id_prefix, page_horizontal_alignment, page_margins, resources_folder, resources_folder_alias, save_font_face_css_separately, show_page_border, use_target_machine_fonts, save_format].hash
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



695
696
697
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 695

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



701
702
703
704
705
706
707
708
709
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 701

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



689
690
691
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 689

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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 430

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)
  color_mode_validator = EnumAttributeValidator.new('String', ["Normal", "Grayscale"])
  return false unless color_mode_validator.valid?(@color_mode)
  numeral_format_validator = EnumAttributeValidator.new('String', ["European", "ArabicIndic", "EasternArabicIndic", "Context", "System"])
  return false unless numeral_format_validator.valid?(@numeral_format)
  font_format_validator = EnumAttributeValidator.new('String', ["Woff", "Ttf"])
  return false unless font_format_validator.valid?(@font_format)
  page_horizontal_alignment_validator = EnumAttributeValidator.new('String', ["Left", "Center", "Right"])
  return false unless page_horizontal_alignment_validator.valid?(@page_horizontal_alignment)

  return true
end

#validateObject

Raises:

  • (ArgumentError)


732
733
734
735
736
737
738
739
740
741
# File 'lib/aspose_words_cloud/models/html_fixed_save_options_data.rb', line 732

def validate()
  raise ArgumentError, 'Property file_name in HtmlFixedSaveOptionsData is required.' if self.file_name.nil?
  unless self.custom_time_zone_info_data.nil?
      self.custom_time_zone_info_data.validate
  end
  unless self.metafile_rendering_options.nil?
      self.metafile_rendering_options.validate
  end

end