Class: WordsRubySdk::TextSaveOptionsData

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

Overview

Container class for text save options.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TextSaveOptionsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



124
125
126
127
128
129
130
131
132
133
134
135
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
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
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 124

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

  if attributes.key?(:'ExportHeadersFooters')
    self.export_headers_footers = attributes[:'ExportHeadersFooters']
  end

  if attributes.key?(:'ForcePageBreaks')
    self.force_page_breaks = attributes[:'ForcePageBreaks']
  end

  if attributes.key?(:'ParagraphBreak')
    self.paragraph_break = attributes[:'ParagraphBreak']
  end

  if attributes.key?(:'PreserveTableLayout')
    self.preserve_table_layout = attributes[:'PreserveTableLayout']
  end

  if attributes.key?(:'SimplifyListLabels')
    self.simplify_list_labels = attributes[:'SimplifyListLabels']
  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/text_save_options_data.rb', line 35

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 }



47
48
49
 
# File 'lib/words_ruby_sdk/models/text_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/text_save_options_data.rb', line 44

def dml_rendering_mode
  @dml_rendering_mode
end

#encoding ⇒ Object

Specifies the encoding to use when exporting in plain text format



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

def encoding
  @encoding
end

#export_headers_footers ⇒ Object

Specifies whether to output headers and footers when exporting in plain text format



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

def export_headers_footers
  @export_headers_footers
end

#file_name ⇒ Object

name of destination file



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

def file_name
  @file_name
end

#force_page_breaks ⇒ Object

Allows to specify whether the page breaks should be preserved during export. The default value is false.



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

def force_page_breaks
  @force_page_breaks
end

#paragraph_break ⇒ Object

Specifies the string to use as a paragraph break when exporting in plain text format



71
72
73
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 71

def paragraph_break
  @paragraph_break
end

#preserve_table_layout ⇒ Object

Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format



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

def preserve_table_layout
  @preserve_table_layout
end

#save_format ⇒ Object

format of save



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

def save_format
  @save_format
end

#simplify_list_labels ⇒ Object

Specifies whether the program should simplify list labels in case of complex label formatting not being adequately represented by plain text



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

def simplify_list_labels
  @simplify_list_labels
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/text_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/text_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/text_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/text_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.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 81

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',
    :'encoding' => :'Encoding',
    :'export_headers_footers' => :'ExportHeadersFooters',
    :'force_page_breaks' => :'ForcePageBreaks',
    :'paragraph_break' => :'ParagraphBreak',
    :'preserve_table_layout' => :'PreserveTableLayout',
    :'simplify_list_labels' => :'SimplifyListLabels'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 102

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',
    :'encoding' => :'String',
    :'export_headers_footers' => :'BOOLEAN',
    :'force_page_breaks' => :'BOOLEAN',
    :'paragraph_break' => :'String',
    :'preserve_table_layout' => :'BOOLEAN',
    :'simplify_list_labels' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 207

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 &&
      encoding == other.encoding &&
      export_headers_footers == other.export_headers_footers &&
      force_page_breaks == other.force_page_breaks &&
      paragraph_break == other.paragraph_break &&
      preserve_table_layout == other.preserve_table_layout &&
      simplify_list_labels == other.simplify_list_labels
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



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

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 331

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 242

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


229
230
231
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 229

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



235
236
237
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 235

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, encoding, export_headers_footers, force_page_breaks, paragraph_break, preserve_table_layout, simplify_list_labels].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



194
195
196
197
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 194

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



311
312
313
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 311

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



317
318
319
320
321
322
323
324
325
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 317

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



305
306
307
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 305

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



201
202
203
 
# File 'lib/words_ruby_sdk/models/text_save_options_data.rb', line 201

def valid?
  return true
end