Class: AsposeWordsCloud::OpenXpsSaveOptionsData

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

Overview

Container class for xps save options.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpenXpsSaveOptionsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 199

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'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?(:'BookmarksOutlineLevel')
    self.bookmarks_outline_level = attributes[:'BookmarksOutlineLevel']
  end

  if attributes.key?(:'HeadingsOutlineLevels')
    self.headings_outline_levels = attributes[:'HeadingsOutlineLevels']
  end

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

  if attributes.key?(:'UseBookFoldPrintingSettings')
    self.use_book_fold_printing_settings = attributes[:'UseBookFoldPrintingSettings']
  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..



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

def allow_embedding_post_script_fonts
  @allow_embedding_post_script_fonts
end

#bookmarks_outline_levelObject

Gets or sets the level in the XPS document outline at which to display Word bookmarks.



99
100
101
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 99

def bookmarks_outline_level
  @bookmarks_outline_level
end

#color_modeObject

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



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

def color_mode
  @color_mode
end

#custom_time_zone_info_dataObject

Gets or sets CustomTimeZoneInfo.



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

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.



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

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 }.



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

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.



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

def dml_rendering_mode
  @dml_rendering_mode
end

#file_nameObject

Gets or sets the name of destination file.



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

def file_name
  @file_name
end

#headings_outline_levelsObject

Gets or sets the number of heading levels (paragraphs formatted with the Heading styles) to include in the XPS document outline.



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

def headings_outline_levels
  @headings_outline_levels
end

#iml_rendering_modeObject

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



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

def iml_rendering_mode
  @iml_rendering_mode
end

#jpeg_qualityObject

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



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

def jpeg_quality
  @jpeg_quality
end

#metafile_rendering_optionsObject

Gets or sets the metafile rendering options.



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

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.



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

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.



90
91
92
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 90

def optimize_output
  @optimize_output
end

#outline_optionsObject

Gets or sets the outline options.



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

def outline_options
  @outline_options
end

#page_countObject

Gets or sets the number of pages to render.



93
94
95
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 93

def page_count
  @page_count
end

#page_indexObject

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



96
97
98
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 96

def page_index
  @page_index
end

#save_formatObject

Gets the format of save.



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

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



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

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.



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

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.



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

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.



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

def update_last_saved_time_property
  @update_last_saved_time_property
end

#update_sdt_contentObject

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



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

def update_sdt_content
  @update_sdt_content
end

#use_book_fold_printing_settingsObject

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



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

def use_book_fold_printing_settings
  @use_book_fold_printing_settings
end

#zip_outputObject

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



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

def zip_output
  @zip_output
end

Class Method Details

.attribute_mapObject

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 136

def self.attribute_map
  {
    :'allow_embedding_post_script_fonts' => :'AllowEmbeddingPostScriptFonts',
    :'custom_time_zone_info_data' => :'CustomTimeZoneInfoData',
    :'dml3_d_effects_rendering_mode' => :'Dml3DEffectsRenderingMode',
    :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode',
    :'dml_rendering_mode' => :'DmlRenderingMode',
    :'file_name' => :'FileName',
    :'iml_rendering_mode' => :'ImlRenderingMode',
    :'update_created_time_property' => :'UpdateCreatedTimeProperty',
    :'update_fields' => :'UpdateFields',
    :'update_last_printed_property' => :'UpdateLastPrintedProperty',
    :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty',
    :'update_sdt_content' => :'UpdateSdtContent',
    :'zip_output' => :'ZipOutput',
    :'color_mode' => :'ColorMode',
    :'jpeg_quality' => :'JpegQuality',
    :'metafile_rendering_options' => :'MetafileRenderingOptions',
    :'numeral_format' => :'NumeralFormat',
    :'optimize_output' => :'OptimizeOutput',
    :'page_count' => :'PageCount',
    :'page_index' => :'PageIndex',
    :'bookmarks_outline_level' => :'BookmarksOutlineLevel',
    :'headings_outline_levels' => :'HeadingsOutlineLevels',
    :'outline_options' => :'OutlineOptions',
    :'use_book_fold_printing_settings' => :'UseBookFoldPrintingSettings',
    :'save_format' => :'SaveFormat'
  }
end

.swagger_typesObject

Attribute type mapping.



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 167

def self.swagger_types
  {
    :'allow_embedding_post_script_fonts' => :'BOOLEAN',
    :'custom_time_zone_info_data' => :'TimeZoneInfoData',
    :'dml3_d_effects_rendering_mode' => :'String',
    :'dml_effects_rendering_mode' => :'String',
    :'dml_rendering_mode' => :'String',
    :'file_name' => :'String',
    :'iml_rendering_mode' => :'String',
    :'update_created_time_property' => :'BOOLEAN',
    :'update_fields' => :'BOOLEAN',
    :'update_last_printed_property' => :'BOOLEAN',
    :'update_last_saved_time_property' => :'BOOLEAN',
    :'update_sdt_content' => :'BOOLEAN',
    :'zip_output' => :'BOOLEAN',
    :'color_mode' => :'String',
    :'jpeg_quality' => :'Integer',
    :'metafile_rendering_options' => :'MetafileRenderingOptionsData',
    :'numeral_format' => :'String',
    :'optimize_output' => :'BOOLEAN',
    :'page_count' => :'Integer',
    :'page_index' => :'Integer',
    :'bookmarks_outline_level' => :'Integer',
    :'headings_outline_levels' => :'Integer',
    :'outline_options' => :'OutlineOptionsData',
    :'use_book_fold_printing_settings' => :'BOOLEAN',
    :'save_format' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      allow_embedding_post_script_fonts == other.allow_embedding_post_script_fonts &&
      custom_time_zone_info_data == other.custom_time_zone_info_data &&
      dml3_d_effects_rendering_mode == other.dml3_d_effects_rendering_mode &&
      dml_effects_rendering_mode == other.dml_effects_rendering_mode &&
      dml_rendering_mode == other.dml_rendering_mode &&
      file_name == other.file_name &&
      iml_rendering_mode == other.iml_rendering_mode &&
      update_created_time_property == other.update_created_time_property &&
      update_fields == other.update_fields &&
      update_last_printed_property == other.update_last_printed_property &&
      update_last_saved_time_property == other.update_last_saved_time_property &&
      update_sdt_content == other.update_sdt_content &&
      zip_output == other.zip_output &&
      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 &&
      bookmarks_outline_level == other.bookmarks_outline_level &&
      headings_outline_levels == other.headings_outline_levels &&
      outline_options == other.outline_options &&
      use_book_fold_printing_settings == other.use_book_fold_printing_settings &&
      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



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

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



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

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



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 462

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



565
566
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 565

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


449
450
451
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 449

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



455
456
457
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 455

def hash
  [allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, update_sdt_content, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, bookmarks_outline_level, headings_outline_levels, outline_options, use_book_fold_printing_settings, save_format].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



306
307
308
309
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 306

def list_invalid_properties
  invalid_properties = []
  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



531
532
533
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 531

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



537
538
539
540
541
542
543
544
545
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 537

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



525
526
527
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 525

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/aspose_words_cloud/models/open_xps_save_options_data.rb', line 313

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)

  return true
end