Class: WordsRubySdk::HtmlFixedSaveOptionsData

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

Overview

container class for fixed html save options

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HtmlFixedSaveOptionsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#color_mode ⇒ Object

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



35
36
37
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 35

def color_mode
  @color_mode
end

#css_class_names_prefix ⇒ Object

Specifies prefix which is added to all class names in style.css file. Default value is "aw".



80
81
82
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 80

def css_class_names_prefix
  @css_class_names_prefix
end

#dml_effects_rendering_mode ⇒ Object

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



47
48
49
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 47

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 }



44
45
46
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 44

def dml_rendering_mode
  @dml_rendering_mode
end

#encoding ⇒ Object

Encoding.



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

def encoding
  @encoding
end

#export_embedded_css ⇒ Object

Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.



86
87
88
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 86

def export_embedded_css
  @export_embedded_css
end

#export_embedded_fonts ⇒ Object

Specifies whether fonts should be embedded into Html document in Base64 format.



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

def export_embedded_fonts
  @export_embedded_fonts
end

#export_embedded_images ⇒ Object

Specifies whether images should be embedded into Html document in Base64 format.



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

def export_embedded_images
  @export_embedded_images
end

#export_form_fields ⇒ Object

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



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

def export_form_fields
  @export_form_fields
end

#file_name ⇒ Object

name of destination file



41
42
43
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 41

def file_name
  @file_name
end

#font_format ⇒ Object

Specifies export format of fonts



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

def font_format
  @font_format
end

#jpeg_quality ⇒ Object

Determines the quality of the JPEG images inside PDF document.



62
63
64
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 62

def jpeg_quality
  @jpeg_quality
end

#metafile_rendering_options ⇒ Object

Allows to specify metafile rendering options.



65
66
67
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 65

def metafile_rendering_options
  @metafile_rendering_options
end

#numeral_format ⇒ Object

Indicates the symbol set that is used to represent numbers while rendering to fixed page formats



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

def numeral_format
  @numeral_format
end

#optimize_output ⇒ Object

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

def optimize_output
  @optimize_output
end

#page_count ⇒ Object

Determines number of pages to render



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

def page_count
  @page_count
end

#page_horizontal_alignment ⇒ Object

Specifies the horizontal alignment of pages in an HTML document. Default value is HtmlFixedHorizontalPageAlignment.Center.



101
102
103
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 101

def page_horizontal_alignment
  @page_horizontal_alignment
end

#page_index ⇒ Object

Determines 0-based index of the first page to render



77
78
79
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 77

def page_index
  @page_index
end

#page_margins ⇒ Object

Specifies the margins around pages in an HTML document. The margins value is measured in points and should be equal to or greater than 0. Default value is 10 points.



104
105
106
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 104

def page_margins
  @page_margins
end

#resources_folder ⇒ Object

Specifies the physical folder where resources are saved when exporting a document



107
108
109
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 107

def resources_folder
  @resources_folder
end

#resources_folder_alias ⇒ Object

Specifies the name of the folder used to construct resource URIs



110
111
112
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 110

def resources_folder_alias
  @resources_folder_alias
end

#save_format ⇒ Object

format of save



38
39
40
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 38

def save_format
  @save_format
end

#show_page_border ⇒ Object

Specifies whether border around pages should be shown.



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

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



59
60
61
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 59

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.



53
54
55
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 53

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.



56
57
58
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 56

def update_sdt_content
  @update_sdt_content
end

#zip_output ⇒ Object

Controls zip output or not. Default value is false.



50
51
52
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 50

def zip_output
  @zip_output
end

Class Method Details

.attribute_map ⇒ Object

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 117

def self.attribute_map
  {
    :'color_mode' => :'ColorMode',
    :'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',
    :'jpeg_quality' => :'JpegQuality',
    :'metafile_rendering_options' => :'MetafileRenderingOptions',
    :'numeral_format' => :'NumeralFormat',
    :'optimize_output' => :'OptimizeOutput',
    :'page_count' => :'PageCount',
    :'page_index' => :'PageIndex',
    :'css_class_names_prefix' => :'CssClassNamesPrefix',
    :'encoding' => :'Encoding',
    :'export_embedded_css' => :'ExportEmbeddedCss',
    :'export_embedded_fonts' => :'ExportEmbeddedFonts',
    :'export_embedded_images' => :'ExportEmbeddedImages',
    :'export_form_fields' => :'ExportFormFields',
    :'font_format' => :'FontFormat',
    :'page_horizontal_alignment' => :'PageHorizontalAlignment',
    :'page_margins' => :'PageMargins',
    :'resources_folder' => :'ResourcesFolder',
    :'resources_folder_alias' => :'ResourcesFolderAlias',
    :'show_page_border' => :'ShowPageBorder'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'color_mode' => :'String',
    :'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',
    :'jpeg_quality' => :'Integer',
    :'metafile_rendering_options' => :'MetafileRenderingOptionsData',
    :'numeral_format' => :'String',
    :'optimize_output' => :'BOOLEAN',
    :'page_count' => :'Integer',
    :'page_index' => :'Integer',
    :'css_class_names_prefix' => :'String',
    :'encoding' => :'String',
    :'export_embedded_css' => :'BOOLEAN',
    :'export_embedded_fonts' => :'BOOLEAN',
    :'export_embedded_images' => :'BOOLEAN',
    :'export_form_fields' => :'BOOLEAN',
    :'font_format' => :'String',
    :'page_horizontal_alignment' => :'String',
    :'page_margins' => :'Float',
    :'resources_folder' => :'String',
    :'resources_folder_alias' => :'String',
    :'show_page_border' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      color_mode == other.color_mode &&
      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 &&
      jpeg_quality == other.jpeg_quality &&
      metafile_rendering_options == other.metafile_rendering_options &&
      numeral_format == other.numeral_format &&
      optimize_output == other.optimize_output &&
      page_count == other.page_count &&
      page_index == other.page_index &&
      css_class_names_prefix == other.css_class_names_prefix &&
      encoding == other.encoding &&
      export_embedded_css == other.export_embedded_css &&
      export_embedded_fonts == other.export_embedded_fonts &&
      export_embedded_images == other.export_embedded_images &&
      export_form_fields == other.export_form_fields &&
      font_format == other.font_format &&
      page_horizontal_alignment == other.page_horizontal_alignment &&
      page_margins == other.page_margins &&
      resources_folder == other.resources_folder &&
      resources_folder_alias == other.resources_folder_alias &&
      show_page_border == other.show_page_border
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



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

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 = WordsRubySdk.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



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 451

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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 362

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


349
350
351
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 349

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



355
356
357
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 355

def hash
  [color_mode, save_format, file_name, dml_rendering_mode, dml_effects_rendering_mode, zip_output, update_last_saved_time_property, update_sdt_content, update_fields, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, css_class_names_prefix, encoding, export_embedded_css, export_embedded_fonts, export_embedded_images, export_form_fields, font_format, page_horizontal_alignment, page_margins, resources_folder, resources_folder_alias, show_page_border].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



302
303
304
305
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 302

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



431
432
433
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 431

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



437
438
439
440
441
442
443
444
445
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 437

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



425
426
427
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 425

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



309
310
311
 
# File 'lib/words_ruby_sdk/models/html_fixed_save_options_data.rb', line 309

def valid?
  return true
end