Class: AsposeWordsCloud::WordMLSaveOptionsData

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

Overview

Container class for wml save options.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WordMLSaveOptionsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



141
142
143
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
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 141

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



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

def allow_embedding_post_script_fonts
  @allow_embedding_post_script_fonts
end

#custom_time_zone_info_data ⇒ Object

Gets or sets CustomTimeZoneInfo.



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

def custom_time_zone_info_data
  @custom_time_zone_info_data
end

#dml3_d_effects_rendering_mode ⇒ Object

Gets or sets the value determining how 3D effects are rendered.



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

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



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

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.



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

def dml_rendering_mode
  @dml_rendering_mode
end

#file_name ⇒ Object

Gets or sets the name of destination file.



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

def file_name
  @file_name
end

#pretty_format ⇒ Object

Gets or sets a value indicating whether to use pretty formats output.



75
76
77
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 75

def pretty_format
  @pretty_format
end

#save_format ⇒ Object

Gets or sets the format of save.



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

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



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

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.



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

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.



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

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.



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

def update_last_saved_time_property
  @update_last_saved_time_property
end

#update_sdt_content ⇒ Object

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



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

def update_sdt_content
  @update_sdt_content
end

#zip_output ⇒ Object

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/word_ml_save_options_data.rb', line 72

def zip_output
  @zip_output
end

Class Method Details

.attribute_map ⇒ Object

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 100

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',
    :'save_format' => :'SaveFormat',
    :'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',
    :'pretty_format' => :'PrettyFormat'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    :'save_format' => :'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',
    :'pretty_format' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 237

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 &&
      save_format == other.save_format &&
      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 &&
      pretty_format == other.pretty_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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 293

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 360

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 271

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


258
259
260
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 258

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



264
265
266
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 264

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, save_format, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, update_sdt_content, zip_output, pretty_format].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



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

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



340
341
342
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 340

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



346
347
348
349
350
351
352
353
354
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 346

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



334
335
336
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 334

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



213
214
215
216
217
218
 
# File 'lib/aspose_words_cloud/models/word_ml_save_options_data.rb', line 213

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)

  return true
end