Class: AsposeWordsCloud::XpsSaveOptionsData

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

Overview

Container class for xps save options.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ XpsSaveOptionsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 144

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?(:'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

#bookmarks_outline_level ⇒ Object

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



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

def bookmarks_outline_level
  @bookmarks_outline_level
end

#color_mode ⇒ Object

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



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

def color_mode
  @color_mode
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/xps_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/xps_save_options_data.rb', line 41

def dml_rendering_mode
  @dml_rendering_mode
end

#file_name ⇒ Object

Gets or sets name of destination file.



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

def file_name
  @file_name
end

#headings_outline_levels ⇒ Object

Gets or sets specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the XPS document outline.



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

def headings_outline_levels
  @headings_outline_levels
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/xps_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/xps_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/xps_save_options_data.rb', line 68

def numeral_format
  @numeral_format
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/xps_save_options_data.rb', line 71

def optimize_output
  @optimize_output
end

#outline_options ⇒ Object

Gets or sets allows to specify outline options.



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

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/xps_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/xps_save_options_data.rb', line 77

def page_index
  @page_index
end

#save_format ⇒ Object

Gets or sets format of save.



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

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



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

def use_book_fold_printing_settings
  @use_book_fold_printing_settings
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/xps_save_options_data.rb', line 47

def zip_output
  @zip_output
end

Class Method Details

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 93

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',
    :'bookmarks_outline_level' => :'BookmarksOutlineLevel',
    :'headings_outline_levels' => :'HeadingsOutlineLevels',
    :'outline_options' => :'OutlineOptions',
    :'use_book_fold_printing_settings' => :'UseBookFoldPrintingSettings'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 118

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',
    :'bookmarks_outline_level' => :'Integer',
    :'headings_outline_levels' => :'Integer',
    :'outline_options' => :'OutlineOptionsData',
    :'use_book_fold_printing_settings' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 243

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



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

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 371

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 282

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


269
270
271
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 269

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



275
276
277
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 275

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, bookmarks_outline_level, headings_outline_levels, outline_options, use_book_fold_printing_settings].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



230
231
232
233
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 230

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



351
352
353
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 351

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



357
358
359
360
361
362
363
364
365
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 357

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



345
346
347
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 345

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



237
238
239
 
# File 'lib/aspose_words_cloud/models/xps_save_options_data.rb', line 237

def valid?
  return true
end