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



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 369

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

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

  if attributes.key?(:'CacheBackgroundGraphics')
    self.cache_background_graphics = attributes[:'CacheBackgroundGraphics']
  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?(:'EmbedAttachments')
    self.embed_attachments = attributes[:'EmbedAttachments']
  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?(:'ExportDocumentStructure')
    self.export_document_structure = attributes[:'ExportDocumentStructure']
  end

  if attributes.key?(:'ExportLanguageToSpanTag')
    self.export_language_to_span_tag = attributes[:'ExportLanguageToSpanTag']
  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?(:'InterpolateImages')
    self.interpolate_images = attributes[:'InterpolateImages']
  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?(:'RenderChoiceFormFieldBorder')
    self.render_choice_form_field_border = attributes[:'RenderChoiceFormFieldBorder']
  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?(:'UseSdtTagAsFormFieldName')
    self.use_sdt_tag_as_form_field_name = attributes[:'UseSdtTagAsFormFieldName']
  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

#allow_embedding_post_script_fonts ⇒ Object

Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.. 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/pdf_save_options_data.rb', line 36

def allow_embedding_post_script_fonts
  @allow_embedding_post_script_fonts
end

#attachments_embedding_mode ⇒ Object

Gets or sets a value determining how attachments are embedded to the PDF document. Default value is None and attachments are not embedded. PDF/A-1, PDF/A-2 and regular PDF/A-4 (not PDF/A-4f) standards do not allow embedded files. None value will be used automatically.



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

def attachments_embedding_mode
  @attachments_embedding_mode
end

#cache_background_graphics ⇒ Object

Gets or sets a value determining whether or not to cache graphics placed in document’s background. Default value is true and background graphics are written to the PDF document as an xObject. When the value is false background graphics are not cached. Some shapes are not supported for caching(shapes with fields, bookmarks, HRefs). Document background graphic is various shapes, charts, images placed in the footer or header, well as background and border of a page.



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

def cache_background_graphics
  @cache_background_graphics
end

#color_mode ⇒ Object

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

def color_mode
  @color_mode
end

#compliance ⇒ Object

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



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

def compliance
  @compliance
end

#create_note_hyperlinks ⇒ Object

Gets or sets a value indicating whether to convert footnote/endnote references in main text story into active hyperlinks. When clicked the hyperlink will lead to the corresponding footnote/endnote. The default value is false.



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

def create_note_hyperlinks
  @create_note_hyperlinks
end

#custom_properties_export ⇒ Object

Gets or sets the option that controls the way CustomDocumentProperties are exported to PDF file. The default value is None.



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

def custom_properties_export
  @custom_properties_export
end

#custom_time_zone_info_data ⇒ Object

Gets or sets CustomTimeZoneInfo.



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

def custom_time_zone_info_data
  @custom_time_zone_info_data
end

#digital_signature_details ⇒ Object

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



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

def digital_signature_details
  @digital_signature_details
end

#display_doc_title ⇒ Object

Gets or sets a value indicating whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary. If false, the title bar should instead display the name of the PDF file containing the document. The default value is false.



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

def display_doc_title
  @display_doc_title
end

#dml3_d_effects_rendering_mode ⇒ Object

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

def dml3_d_effects_rendering_mode
  @dml3_d_effects_rendering_mode
end

#dml_effects_rendering_mode ⇒ Object

Gets or sets the value determining how DrawingML effects are rendered. { Simplified | None | Fine }. 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/pdf_save_options_data.rb', line 49

def dml_effects_rendering_mode
  @dml_effects_rendering_mode
end

#dml_rendering_mode ⇒ Object

Gets or sets the option that controls how DrawingML shapes are rendered. { 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/pdf_save_options_data.rb', line 54

def dml_rendering_mode
  @dml_rendering_mode
end

#downsample_options ⇒ Object

Gets or sets the downsample options.



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

def downsample_options
  @downsample_options
end

#embed_attachments ⇒ Object

Gets or sets a value determining whether or not to embed attachments to the PDF document. Default value is false and attachments are not embedded. When the value is true attachments are embedded to the PDF document. Embedding attachments is not supported when saving to PDF/A and PDF/UA compliance. false value will be used automatically. Embedding attachments is not supported when encryption is enabled. false value will be used automatically.



151
152
153
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 151

def embed_attachments
  @embed_attachments
end

#embed_full_fonts ⇒ Object

Gets or sets a value indicating whether fonts are embedded into the resulting PDF documents.



154
155
156
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 154

def embed_full_fonts
  @embed_full_fonts
end

#encryption_details ⇒ Object

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



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

def encryption_details
  @encryption_details
end

#export_document_structure ⇒ Object

Gets or sets a value indicating whether to export document structure.



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

def export_document_structure
  @export_document_structure
end

#export_language_to_span_tag ⇒ Object

Gets or sets a value determining whether or not to create a “Span” tag in the document structure to export the text language. Default value is false and “Lang” attribute is attached to a marked-content sequence in a page content stream. When the value is true “Span” tag is created for the text with non-default language and “Lang” attribute is attached to this tag. This value is ignored when Aspose.Words.Saving.PdfSaveOptions.ExportDocumentStructure is false.



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

def export_language_to_span_tag
  @export_language_to_span_tag
end

#file_name ⇒ Object

Gets or sets the name of destination file.



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

def file_name
  @file_name
end

#font_embedding_mode ⇒ Object

Gets or sets the font embedding mode.



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

def font_embedding_mode
  @font_embedding_mode
end

#header_footer_bookmarks_export_mode ⇒ Object

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



173
174
175
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 173

def header_footer_bookmarks_export_mode
  @header_footer_bookmarks_export_mode
end

#image_color_space_export_mode ⇒ Object

Gets or sets the option that controls how the color space will be selected for the images in PDF document. The default value is “Auto”. If “SimpleCmyk” value is specified, ImageCompression option is ignored and Flate compression is used for all images in the document.



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

def image_color_space_export_mode
  @image_color_space_export_mode
end

#image_compression ⇒ Object

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



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

def image_compression
  @image_compression
end

#iml_rendering_mode ⇒ Object

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

def iml_rendering_mode
  @iml_rendering_mode
end

#interpolate_images ⇒ Object

Gets or sets a value indicating whether image interpolation shall be performed by a conforming reader. When false is specified, the flag is not written to the output document and the default behavior of reader is used instead. When the resolution of a source image is significantly lower than that of the output device, each source sample covers many device pixels. As a result, images can appear jaggy or blocky. These visual artifacts can be reduced by applying an image interpolation algorithm during rendering. Instead of painting all pixels covered by a source sample with the same color, image interpolation attempts to produce a smooth transition between adjacent sample values. A conforming Reader may choose to not implement this feature of PDF, or may use any specific implementation of interpolation that it wishes. The default value is false.



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

def interpolate_images
  @interpolate_images
end

#jpeg_quality ⇒ Object

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



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

def jpeg_quality
  @jpeg_quality
end

#metafile_rendering_options ⇒ Object

Gets or sets the metafile rendering options.



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

def metafile_rendering_options
  @metafile_rendering_options
end

#numeral_format ⇒ Object

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

def numeral_format
  @numeral_format
end

#open_hyperlinks_in_new_window ⇒ Object

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



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

def open_hyperlinks_in_new_window
  @open_hyperlinks_in_new_window
end

#optimize_output ⇒ Object

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

def optimize_output
  @optimize_output
end

#outline_options ⇒ Object

Gets or sets the outline options.



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

def outline_options
  @outline_options
end

#page_count ⇒ Object

Gets or sets the number of pages to render.



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

def page_count
  @page_count
end

#page_index ⇒ Object

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



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

def page_index
  @page_index
end

#page_mode ⇒ Object

Gets or sets the option that controls how the PDF document should be displayed when opened in the PDF reader.



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

def page_mode
  @page_mode
end

#preblend_images ⇒ Object

Gets or sets a value indicating whether to preblend transparent images with black background color. Preblending images may improve PDF document visual appearance in Adobe Reader and remove anti-aliasing artifacts.In order to properly display preblended images, PDF viewer application must support /Matte entry in soft-mask image dictionary. Also preblending images may decrease PDF rendering performance.The default value is false.



198
199
200
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 198

def preblend_images
  @preblend_images
end

#preserve_form_fields ⇒ Object

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



201
202
203
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 201

def preserve_form_fields
  @preserve_form_fields
end

#render_choice_form_field_border ⇒ Object

Gets or sets a value indicating whether to render PDF choice form field border. PDF choice form fields are used for export of SDT Combo Box Content Control, SDT Drop-Down List Content Control and legacy Drop-Down Form Field when PreserveFormFields option is enabled.The default value is true.



206
207
208
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 206

def render_choice_form_field_border
  @render_choice_form_field_border
end

#save_format ⇒ Object

Gets the format of save.



229
230
231
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 229

def save_format
  @save_format
end

#text_compression ⇒ Object

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



209
210
211
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 209

def text_compression
  @text_compression
end

#update_ambiguous_text_font ⇒ Object

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

def update_ambiguous_text_font
  @update_ambiguous_text_font
end

#update_created_time_property ⇒ Object

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



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

def update_created_time_property
  @update_created_time_property
end

#update_fields ⇒ Object

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



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

def update_fields
  @update_fields
end

#update_last_printed_property ⇒ Object

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



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

def update_last_printed_property
  @update_last_printed_property
end

#update_last_saved_time_property ⇒ Object

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



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

def update_last_saved_time_property
  @update_last_saved_time_property
end

#use_book_fold_printing_settings ⇒ Object

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



212
213
214
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 212

def use_book_fold_printing_settings
  @use_book_fold_printing_settings
end

#use_core_fonts ⇒ Object

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



215
216
217
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 215

def use_core_fonts
  @use_core_fonts
end

#use_sdt_tag_as_form_field_name ⇒ Object

Gets or sets a value indicating whether to use SDT control Tag or Id property as a name of form field in PDF. The default value is false.When set to false, SDT control Id property is used as a name of form field in PDF.When set to true, SDT control Tag property is used as a name of form field in PDF.If set to true and Tag is empty, Id property will be used as a form field name.If set to true and Tag values are not unique, duplicate Tag values will be altered to build unique PDF form field names.



220
221
222
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 220

def use_sdt_tag_as_form_field_name
  @use_sdt_tag_as_form_field_name
end

#zip_output ⇒ Object

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

def zip_output
  @zip_output
end

#zoom_behavior ⇒ Object

Gets or sets the option that controls what type of zoom should be applied when a document is opened with a PDF viewer.



223
224
225
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 223

def zoom_behavior
  @zoom_behavior
end

#zoom_factor ⇒ Object

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



226
227
228
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 226

def zoom_factor
  @zoom_factor
end

Class Method Details

.attribute_map ⇒ Object

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 254

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',
    :'attachments_embedding_mode' => :'AttachmentsEmbeddingMode',
    :'cache_background_graphics' => :'CacheBackgroundGraphics',
    :'compliance' => :'Compliance',
    :'create_note_hyperlinks' => :'CreateNoteHyperlinks',
    :'custom_properties_export' => :'CustomPropertiesExport',
    :'digital_signature_details' => :'DigitalSignatureDetails',
    :'display_doc_title' => :'DisplayDocTitle',
    :'downsample_options' => :'DownsampleOptions',
    :'embed_attachments' => :'EmbedAttachments',
    :'embed_full_fonts' => :'EmbedFullFonts',
    :'encryption_details' => :'EncryptionDetails',
    :'export_document_structure' => :'ExportDocumentStructure',
    :'export_language_to_span_tag' => :'ExportLanguageToSpanTag',
    :'font_embedding_mode' => :'FontEmbeddingMode',
    :'header_footer_bookmarks_export_mode' => :'HeaderFooterBookmarksExportMode',
    :'image_color_space_export_mode' => :'ImageColorSpaceExportMode',
    :'image_compression' => :'ImageCompression',
    :'interpolate_images' => :'InterpolateImages',
    :'open_hyperlinks_in_new_window' => :'OpenHyperlinksInNewWindow',
    :'outline_options' => :'OutlineOptions',
    :'page_mode' => :'PageMode',
    :'preblend_images' => :'PreblendImages',
    :'preserve_form_fields' => :'PreserveFormFields',
    :'render_choice_form_field_border' => :'RenderChoiceFormFieldBorder',
    :'text_compression' => :'TextCompression',
    :'use_book_fold_printing_settings' => :'UseBookFoldPrintingSettings',
    :'use_core_fonts' => :'UseCoreFonts',
    :'use_sdt_tag_as_form_field_name' => :'UseSdtTagAsFormFieldName',
    :'zoom_behavior' => :'ZoomBehavior',
    :'zoom_factor' => :'ZoomFactor',
    :'save_format' => :'SaveFormat'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    :'attachments_embedding_mode' => :'String',
    :'cache_background_graphics' => :'BOOLEAN',
    :'compliance' => :'String',
    :'create_note_hyperlinks' => :'BOOLEAN',
    :'custom_properties_export' => :'String',
    :'digital_signature_details' => :'PdfDigitalSignatureDetailsData',
    :'display_doc_title' => :'BOOLEAN',
    :'downsample_options' => :'DownsampleOptionsData',
    :'embed_attachments' => :'BOOLEAN',
    :'embed_full_fonts' => :'BOOLEAN',
    :'encryption_details' => :'PdfEncryptionDetailsData',
    :'export_document_structure' => :'BOOLEAN',
    :'export_language_to_span_tag' => :'BOOLEAN',
    :'font_embedding_mode' => :'String',
    :'header_footer_bookmarks_export_mode' => :'String',
    :'image_color_space_export_mode' => :'String',
    :'image_compression' => :'String',
    :'interpolate_images' => :'BOOLEAN',
    :'open_hyperlinks_in_new_window' => :'BOOLEAN',
    :'outline_options' => :'OutlineOptionsData',
    :'page_mode' => :'String',
    :'preblend_images' => :'BOOLEAN',
    :'preserve_form_fields' => :'BOOLEAN',
    :'render_choice_form_field_border' => :'BOOLEAN',
    :'text_compression' => :'String',
    :'use_book_fold_printing_settings' => :'BOOLEAN',
    :'use_core_fonts' => :'BOOLEAN',
    :'use_sdt_tag_as_form_field_name' => :'BOOLEAN',
    :'zoom_behavior' => :'String',
    :'zoom_factor' => :'Integer',
    :'save_format' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 828

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 &&
      attachments_embedding_mode == other.attachments_embedding_mode &&
      cache_background_graphics == other.cache_background_graphics &&
      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_attachments == other.embed_attachments &&
      embed_full_fonts == other.embed_full_fonts &&
      encryption_details == other.encryption_details &&
      export_document_structure == other.export_document_structure &&
      export_language_to_span_tag == other.export_language_to_span_tag &&
      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 &&
      interpolate_images == other.interpolate_images &&
      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 &&
      render_choice_form_field_border == other.render_choice_form_field_border &&
      text_compression == other.text_compression &&
      use_book_fold_printing_settings == other.use_book_fold_printing_settings &&
      use_core_fonts == other.use_core_fonts &&
      use_sdt_tag_as_form_field_name == other.use_sdt_tag_as_form_field_name &&
      zoom_behavior == other.zoom_behavior &&
      zoom_factor == other.zoom_factor &&
      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



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 921

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



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 992

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



899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 899

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 



1006
1007
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 1006

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


886
887
888
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 886

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



892
893
894
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 892

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, attachments_embedding_mode, cache_background_graphics, compliance, create_note_hyperlinks, custom_properties_export, digital_signature_details, display_doc_title, downsample_options, embed_attachments, embed_full_fonts, encryption_details, export_document_structure, export_language_to_span_tag, font_embedding_mode, header_footer_bookmarks_export_mode, image_color_space_export_mode, image_compression, interpolate_images, open_hyperlinks_in_new_window, outline_options, page_mode, preblend_images, preserve_form_fields, render_choice_form_field_border, text_compression, use_book_fold_printing_settings, use_core_fonts, use_sdt_tag_as_form_field_name, zoom_behavior, zoom_factor, save_format].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



972
973
974
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 972

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



978
979
980
981
982
983
984
985
986
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 978

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



966
967
968
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 966

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



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
606
607
608
609
610
611
612
613
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 580

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)
  attachments_embedding_mode_validator = EnumAttributeValidator.new('String', ["None", "Annotations", "DocumentEmbeddedFiles"])
  return false unless attachments_embedding_mode_validator.valid?(@attachments_embedding_mode)
  compliance_validator = EnumAttributeValidator.new('String', ["Pdf17", "Pdf20", "PdfA1a", "PdfA1b", "PdfA2a", "PdfA2u", "PdfA3a", "PdfA3u", "PdfA4", "PdfA4f", "PdfA4Ua2", "PdfUa1", "PdfUa2"])
  return false unless compliance_validator.valid?(@compliance)
  custom_properties_export_validator = EnumAttributeValidator.new('String', ["None", "Standard", "Metadata"])
  return false unless custom_properties_export_validator.valid?(@custom_properties_export)
  font_embedding_mode_validator = EnumAttributeValidator.new('String', ["EmbedAll", "EmbedNonstandard", "EmbedNone"])
  return false unless font_embedding_mode_validator.valid?(@font_embedding_mode)
  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)
  image_color_space_export_mode_validator = EnumAttributeValidator.new('String', ["Auto", "SimpleCmyk"])
  return false unless image_color_space_export_mode_validator.valid?(@image_color_space_export_mode)
  page_mode_validator = EnumAttributeValidator.new('String', ["UseNone", "UseOutlines", "UseThumbs", "FullScreen", "UseOC", "UseAttachments"])
  return false unless page_mode_validator.valid?(@page_mode)
  text_compression_validator = EnumAttributeValidator.new('String', ["None", "Flate"])
  return false unless text_compression_validator.valid?(@text_compression)
  zoom_behavior_validator = EnumAttributeValidator.new('String', ["None", "ZoomFactor", "FitPage", "FitWidth", "FitHeight", "FitBox"])
  return false unless zoom_behavior_validator.valid?(@zoom_behavior)

  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'lib/aspose_words_cloud/models/pdf_save_options_data.rb', line 1009

def validate()
  raise ArgumentError, 'Property file_name in PdfSaveOptionsData 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
  unless self.digital_signature_details.nil?
      self.digital_signature_details.validate
  end
  unless self.downsample_options.nil?
      self.downsample_options.validate
  end
  unless self.encryption_details.nil?
      self.encryption_details.validate
  end
  unless self.outline_options.nil?
      self.outline_options.validate
  end

end