Class: AsposeWordsCloud::PdfSaveOptionsData

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

Overview

container class for pdf save options.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PdfSaveOptionsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
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
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 265

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

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

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

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

  if attributes.key?(:'ZipOutput')
    self.zip_output = attributes[:'ZipOutput']
  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?(:'UpdateFields')
    self.update_fields = attributes[:'UpdateFields']
  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?(:'Compliance')
    self.compliance = attributes[:'Compliance']
  end

  if attributes.key?(:'CreateNoteHyperlinks')
    self.create_note_hyperlinks = attributes[:'CreateNoteHyperlinks']
  end

  if attributes.key?(:'CustomPropertiesExport')
    self.custom_properties_export = attributes[:'CustomPropertiesExport']
  end

  if attributes.key?(:'DigitalSignatureDetails')
    self.digital_signature_details = attributes[:'DigitalSignatureDetails']
  end

  if attributes.key?(:'DisplayDocTitle')
    self.display_doc_title = attributes[:'DisplayDocTitle']
  end

  if attributes.key?(:'DownsampleOptions')
    self.downsample_options = attributes[:'DownsampleOptions']
  end

  if attributes.key?(:'EmbedFullFonts')
    self.embed_full_fonts = attributes[:'EmbedFullFonts']
  end

  if attributes.key?(:'EncryptionDetails')
    self.encryption_details = attributes[:'EncryptionDetails']
  end

  if attributes.key?(:'EscapeUri')
    self.escape_uri = attributes[:'EscapeUri']
  end

  if attributes.key?(:'ExportDocumentStructure')
    self.export_document_structure = attributes[:'ExportDocumentStructure']
  end

  if attributes.key?(:'FontEmbeddingMode')
    self.font_embedding_mode = attributes[:'FontEmbeddingMode']
  end

  if attributes.key?(:'HeaderFooterBookmarksExportMode')
    self.header_footer_bookmarks_export_mode = attributes[:'HeaderFooterBookmarksExportMode']
  end

  if attributes.key?(:'ImageColorSpaceExportMode')
    self.image_color_space_export_mode = attributes[:'ImageColorSpaceExportMode']
  end

  if attributes.key?(:'ImageCompression')
    self.image_compression = attributes[:'ImageCompression']
  end

  if attributes.key?(:'OpenHyperlinksInNewWindow')
    self.open_hyperlinks_in_new_window = attributes[:'OpenHyperlinksInNewWindow']
  end

  if attributes.key?(:'OutlineOptions')
    self.outline_options = attributes[:'OutlineOptions']
  end

  if attributes.key?(:'PageMode')
    self.page_mode = attributes[:'PageMode']
  end

  if attributes.key?(:'PreblendImages')
    self.preblend_images = attributes[:'PreblendImages']
  end

  if attributes.key?(:'PreserveFormFields')
    self.preserve_form_fields = attributes[:'PreserveFormFields']
  end

  if attributes.key?(:'TextCompression')
    self.text_compression = attributes[:'TextCompression']
  end

  if attributes.key?(:'UseBookFoldPrintingSettings')
    self.use_book_fold_printing_settings = attributes[:'UseBookFoldPrintingSettings']
  end

  if attributes.key?(:'UseCoreFonts')
    self.use_core_fonts = attributes[:'UseCoreFonts']
  end

  if attributes.key?(:'ZoomBehavior')
    self.zoom_behavior = attributes[:'ZoomBehavior']
  end

  if attributes.key?(:'ZoomFactor')
    self.zoom_factor = attributes[:'ZoomFactor']
  end

end

Instance Attribute Details

#color_mode ⇒ Object

Gets or sets a value determining how colors are rendered. { Normal | Grayscale}.



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

def color_mode
  @color_mode
end

#compliance ⇒ Object

Gets or sets specifies the PDF standards compliance level for output documents.



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

def compliance
  @compliance
end

#create_note_hyperlinks ⇒ Object

Gets or sets specifies whether to convert footnote/endnote references in main text story into active hyperlinks. When clicked the hyperlink will lead to the corresponding footnote/endnote. Default is false.



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

def create_note_hyperlinks
  @create_note_hyperlinks
end

#custom_properties_export ⇒ Object

Gets or sets a value determining the way are exported to PDF file. Default value is .



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

def custom_properties_export
  @custom_properties_export
end

#digital_signature_details ⇒ Object

Gets or sets specifies the details for signing the output PDF document.



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

def digital_signature_details
  @digital_signature_details
end

#display_doc_title ⇒ Object

Gets or sets a flag specifying whether the window???s title bar should display the document title taken from the Title entry of the document information dictionary.



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

def display_doc_title
  @display_doc_title
end

#dml_effects_rendering_mode ⇒ Object

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



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

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/pdf_save_options_data.rb', line 41

def dml_rendering_mode
  @dml_rendering_mode
end

#downsample_options ⇒ Object

Gets or sets allows to specify downsample options.



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

def downsample_options
  @downsample_options
end

#embed_full_fonts ⇒ Object

Gets or sets controls how fonts are embedded into the resulting PDF documents.



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

def embed_full_fonts
  @embed_full_fonts
end

#encryption_details ⇒ Object

Gets or sets specifies the details for encrypting the output PDF document.



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

def encryption_details
  @encryption_details
end

#escape_uri ⇒ Object

Gets or sets a flag specifying whether URI should be escaped before writing.



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

def escape_uri
  @escape_uri
end

#export_document_structure ⇒ Object

Gets or sets determines whether or not to export document structure.



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

def export_document_structure
  @export_document_structure
end

#file_name ⇒ Object

Gets or sets name of destination file.



38
39
40
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 38

def file_name
  @file_name
end

#font_embedding_mode ⇒ Object

Gets or sets specifies the font embedding mode.



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

def font_embedding_mode
  @font_embedding_mode
end

#header_footer_bookmarks_export_mode ⇒ Object

Gets or sets determines how bookmarks in headers/footers are exported. The default value is Aspose.Words.Saving.HeaderFooterBookmarksExportMode.All.



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

def header_footer_bookmarks_export_mode
  @header_footer_bookmarks_export_mode
end

#image_color_space_export_mode ⇒ Object

Gets or sets specifies how the color space will be selected for the images in PDF document.



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

def image_color_space_export_mode
  @image_color_space_export_mode
end

#image_compression ⇒ Object

Gets or sets specifies compression type to be used for all images in the document.



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

def image_compression
  @image_compression
end

#jpeg_quality ⇒ Object

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



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

def jpeg_quality
  @jpeg_quality
end

#metafile_rendering_options ⇒ Object

Gets or sets allows to specify metafile rendering options.



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

def metafile_rendering_options
  @metafile_rendering_options
end

#numeral_format ⇒ Object

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



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

def numeral_format
  @numeral_format
end

#open_hyperlinks_in_new_window ⇒ Object

Gets or sets determines whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser.



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

def open_hyperlinks_in_new_window
  @open_hyperlinks_in_new_window
end

#optimize_output ⇒ Object

Gets or sets flag indicates 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. Default is false.



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

def optimize_output
  @optimize_output
end

#outline_options ⇒ Object

Gets or sets allows to specify outline options.



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

def outline_options
  @outline_options
end

#page_count ⇒ Object

Gets or sets determines number of pages to render.



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

def page_count
  @page_count
end

#page_index ⇒ Object

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



77
78
79
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 77

def page_index
  @page_index
end

#page_mode ⇒ Object

Gets or sets specifies how the PDF document should be displayed when opened in the PDF reader.



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

def page_mode
  @page_mode
end

#preblend_images ⇒ Object

Gets or sets a value determining whether or not to preblend transparent images with black background color.



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

def preblend_images
  @preblend_images
end

#preserve_form_fields ⇒ Object

Gets or sets specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text.



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

def preserve_form_fields
  @preserve_form_fields
end

#save_format ⇒ Object

Gets or sets format of save.



35
36
37
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 35

def save_format
  @save_format
end

#text_compression ⇒ Object

Gets or sets specifies compression type to be used for all textual content in the document.



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

def text_compression
  @text_compression
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



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

def update_fields
  @update_fields
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.



50
51
52
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 50

def update_last_saved_time_property
  @update_last_saved_time_property
end

#update_sdt_content ⇒ Object

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



53
54
55
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 53

def update_sdt_content
  @update_sdt_content
end

#use_book_fold_printing_settings ⇒ Object

Gets or sets determines whether the document should be saved using a booklet printing layout.



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

def use_book_fold_printing_settings
  @use_book_fold_printing_settings
end

#use_core_fonts ⇒ Object

Gets or sets determines whether or not to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts.



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

def use_core_fonts
  @use_core_fonts
end

#zip_output ⇒ Object

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



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

def zip_output
  @zip_output
end

#zoom_behavior ⇒ Object

Gets or sets determines what type of zoom should be applied when a document is opened with a PDF viewer.



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

def zoom_behavior
  @zoom_behavior
end

#zoom_factor ⇒ Object

Gets or sets determines zoom factor (in percentages) for a document.



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

def zoom_factor
  @zoom_factor
end

Class Method Details

.attribute_map ⇒ Object

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 174

def self.attribute_map
  {
    :'save_format' => :'SaveFormat',
    :'file_name' => :'FileName',
    :'dml_rendering_mode' => :'DmlRenderingMode',
    :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode',
    :'zip_output' => :'ZipOutput',
    :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty',
    :'update_sdt_content' => :'UpdateSdtContent',
    :'update_fields' => :'UpdateFields',
    :'color_mode' => :'ColorMode',
    :'jpeg_quality' => :'JpegQuality',
    :'metafile_rendering_options' => :'MetafileRenderingOptions',
    :'numeral_format' => :'NumeralFormat',
    :'optimize_output' => :'OptimizeOutput',
    :'page_count' => :'PageCount',
    :'page_index' => :'PageIndex',
    :'compliance' => :'Compliance',
    :'create_note_hyperlinks' => :'CreateNoteHyperlinks',
    :'custom_properties_export' => :'CustomPropertiesExport',
    :'digital_signature_details' => :'DigitalSignatureDetails',
    :'display_doc_title' => :'DisplayDocTitle',
    :'downsample_options' => :'DownsampleOptions',
    :'embed_full_fonts' => :'EmbedFullFonts',
    :'encryption_details' => :'EncryptionDetails',
    :'escape_uri' => :'EscapeUri',
    :'export_document_structure' => :'ExportDocumentStructure',
    :'font_embedding_mode' => :'FontEmbeddingMode',
    :'header_footer_bookmarks_export_mode' => :'HeaderFooterBookmarksExportMode',
    :'image_color_space_export_mode' => :'ImageColorSpaceExportMode',
    :'image_compression' => :'ImageCompression',
    :'open_hyperlinks_in_new_window' => :'OpenHyperlinksInNewWindow',
    :'outline_options' => :'OutlineOptions',
    :'page_mode' => :'PageMode',
    :'preblend_images' => :'PreblendImages',
    :'preserve_form_fields' => :'PreserveFormFields',
    :'text_compression' => :'TextCompression',
    :'use_book_fold_printing_settings' => :'UseBookFoldPrintingSettings',
    :'use_core_fonts' => :'UseCoreFonts',
    :'zoom_behavior' => :'ZoomBehavior',
    :'zoom_factor' => :'ZoomFactor'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 219

def self.swagger_types
  {
    :'save_format' => :'String',
    :'file_name' => :'String',
    :'dml_rendering_mode' => :'String',
    :'dml_effects_rendering_mode' => :'String',
    :'zip_output' => :'BOOLEAN',
    :'update_last_saved_time_property' => :'BOOLEAN',
    :'update_sdt_content' => :'BOOLEAN',
    :'update_fields' => :'BOOLEAN',
    :'color_mode' => :'String',
    :'jpeg_quality' => :'Integer',
    :'metafile_rendering_options' => :'MetafileRenderingOptionsData',
    :'numeral_format' => :'String',
    :'optimize_output' => :'BOOLEAN',
    :'page_count' => :'Integer',
    :'page_index' => :'Integer',
    :'compliance' => :'String',
    :'create_note_hyperlinks' => :'BOOLEAN',
    :'custom_properties_export' => :'String',
    :'digital_signature_details' => :'PdfDigitalSignatureDetailsData',
    :'display_doc_title' => :'BOOLEAN',
    :'downsample_options' => :'DownsampleOptionsData',
    :'embed_full_fonts' => :'BOOLEAN',
    :'encryption_details' => :'PdfEncryptionDetailsData',
    :'escape_uri' => :'BOOLEAN',
    :'export_document_structure' => :'BOOLEAN',
    :'font_embedding_mode' => :'String',
    :'header_footer_bookmarks_export_mode' => :'String',
    :'image_color_space_export_mode' => :'String',
    :'image_compression' => :'String',
    :'open_hyperlinks_in_new_window' => :'BOOLEAN',
    :'outline_options' => :'OutlineOptionsData',
    :'page_mode' => :'String',
    :'preblend_images' => :'BOOLEAN',
    :'preserve_form_fields' => :'BOOLEAN',
    :'text_compression' => :'String',
    :'use_book_fold_printing_settings' => :'BOOLEAN',
    :'use_core_fonts' => :'BOOLEAN',
    :'zoom_behavior' => :'String',
    :'zoom_factor' => :'Integer'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      save_format == other.save_format &&
      file_name == other.file_name &&
      dml_rendering_mode == other.dml_rendering_mode &&
      dml_effects_rendering_mode == other.dml_effects_rendering_mode &&
      zip_output == other.zip_output &&
      update_last_saved_time_property == other.update_last_saved_time_property &&
      update_sdt_content == other.update_sdt_content &&
      update_fields == other.update_fields &&
      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 &&
      compliance == other.compliance &&
      create_note_hyperlinks == other.create_note_hyperlinks &&
      custom_properties_export == other.custom_properties_export &&
      digital_signature_details == other.digital_signature_details &&
      display_doc_title == other.display_doc_title &&
      downsample_options == other.downsample_options &&
      embed_full_fonts == other.embed_full_fonts &&
      encryption_details == other.encryption_details &&
      escape_uri == other.escape_uri &&
      export_document_structure == other.export_document_structure &&
      font_embedding_mode == other.font_embedding_mode &&
      header_footer_bookmarks_export_mode == other.header_footer_bookmarks_export_mode &&
      image_color_space_export_mode == other.image_color_space_export_mode &&
      image_compression == other.image_compression &&
      open_hyperlinks_in_new_window == other.open_hyperlinks_in_new_window &&
      outline_options == other.outline_options &&
      page_mode == other.page_mode &&
      preblend_images == other.preblend_images &&
      preserve_form_fields == other.preserve_form_fields &&
      text_compression == other.text_compression &&
      use_book_fold_printing_settings == other.use_book_fold_printing_settings &&
      use_core_fonts == other.use_core_fonts &&
      zoom_behavior == other.zoom_behavior &&
      zoom_factor == other.zoom_factor
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



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 541

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



608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 608

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



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 519

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


506
507
508
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 506

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



512
513
514
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 512

def hash
  [save_format, file_name, dml_rendering_mode, dml_effects_rendering_mode, zip_output, update_last_saved_time_property, update_sdt_content, update_fields, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, compliance, create_note_hyperlinks, custom_properties_export, digital_signature_details, display_doc_title, downsample_options, embed_full_fonts, encryption_details, escape_uri, export_document_structure, font_embedding_mode, header_footer_bookmarks_export_mode, image_color_space_export_mode, image_compression, open_hyperlinks_in_new_window, outline_options, page_mode, preblend_images, preserve_form_fields, text_compression, use_book_fold_printing_settings, use_core_fonts, zoom_behavior, zoom_factor].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



431
432
433
434
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 431

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



588
589
590
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 588

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



594
595
596
597
598
599
600
601
602
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 594

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



582
583
584
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 582

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



438
439
440
441
442
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 438

def valid?
  header_footer_bookmarks_export_mode_validator = EnumAttributeValidator.new('String', ["None", "First", "All"])
  return false unless header_footer_bookmarks_export_mode_validator.valid?(@header_footer_bookmarks_export_mode)
  return true
end