Class: AsposeWordsCloud::TextSaveOptionsData

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

Overview

Container class for text save options.

Defined Under Namespace

Classes: EnumAttributeValidator

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



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

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

  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?(:'UpdateAmbiguousTextFont')
    self.update_ambiguous_text_font = attributes[:'UpdateAmbiguousTextFont']
  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?(:'ZipOutput')
    self.zip_output = attributes[:'ZipOutput']
  end

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

  if attributes.key?(:'ExportHeadersFootersMode')
    self.export_headers_footers_mode = attributes[:'ExportHeadersFootersMode']
  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?(:'AddBidiMarks')
    self.add_bidi_marks = attributes[:'AddBidiMarks']
  end

  if attributes.key?(:'MaxCharactersPerLine')
    self.max_characters_per_line = attributes[:'MaxCharactersPerLine']
  end

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

#add_bidi_marks ⇒ Object

Gets or sets a value indicating whether to add bi-directional marks before each BiDi run when exporting in plain text format. The default value is true.



101
102
103
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 101

def add_bidi_marks
  @add_bidi_marks
end

#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.. Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type. This option only works when Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts of the Aspose.Words.DocumentBase.FontInfos property is set to true. The default value is false.



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

def allow_embedding_post_script_fonts
  @allow_embedding_post_script_fonts
end

#custom_time_zone_info_data ⇒ Object

Gets or sets CustomTimeZoneInfo.



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

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. The default value is Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic.



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

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 }. The default value is Simplified. This property is used when the document is exported to fixed page formats.



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

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. { Fallback | DrawingML }. The default value is Fallback. This property is used when the document is exported to fixed page formats.



54
55
56
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 54

def dml_rendering_mode
  @dml_rendering_mode
end

#encoding ⇒ Object

Gets or sets the character encoding to use when exporting in plain text format.



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

def encoding
  @encoding
end

#export_headers_footers_mode ⇒ Object

Gets or sets the option that controls whether to output headers and footers when exporting in plain text format. The default value is TxtExportHeadersFootersMode.PrimaryOnly.



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

def export_headers_footers_mode
  @export_headers_footers_mode
end

#file_name ⇒ Object

Gets or sets the name of destination file.



57
58
59
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 57

def file_name
  @file_name
end

#force_page_breaks ⇒ Object

Gets or sets a value indicating whether the page breaks should be preserved during export. The default value is false.



94
95
96
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 94

def force_page_breaks
  @force_page_breaks
end

#iml_rendering_mode ⇒ Object

Gets or sets the value determining how ink (InkML) objects are rendered. The default value is Aspose.Words.Saving.ImlRenderingMode.InkML.



61
62
63
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 61

def iml_rendering_mode
  @iml_rendering_mode
end

#max_characters_per_line ⇒ Object

Gets or sets an integer value that specifies the maximum number of characters per one line. The default value is 0, that means no limit.



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

def max_characters_per_line
  @max_characters_per_line
end

#office_math_export_mode ⇒ Object

Gets or sets a value that specifies how OfficeMath will be written to the output file. The default value is Text.



109
110
111
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 109

def office_math_export_mode
  @office_math_export_mode
end

#paragraph_break ⇒ Object

Gets or sets the string to use as a paragraph break when exporting in plain text format.



97
98
99
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 97

def paragraph_break
  @paragraph_break
end

#preserve_table_layout ⇒ Object

Gets or sets a value indicating whether the program should attempt to preserve layout of tables when saving in the plain text format.



112
113
114
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 112

def preserve_table_layout
  @preserve_table_layout
end

#save_format ⇒ Object

Gets the format of save.



118
119
120
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 118

def save_format
  @save_format
end

#simplify_list_labels ⇒ Object

Gets or sets a value indicating whether the program should simplify list labels in case of complex label formatting not being adequately represented by plain text.



115
116
117
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 115

def simplify_list_labels
  @simplify_list_labels
end

#update_ambiguous_text_font ⇒ Object

Gets or sets a value indicating whether the font attributes will be changed according to the character code being used.



64
65
66
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 64

def update_ambiguous_text_font
  @update_ambiguous_text_font
end

#update_created_time_property ⇒ Object

Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving. The default value is false.



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

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.



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

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.



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

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. The default value is false.



78
79
80
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 78

def update_last_saved_time_property
  @update_last_saved_time_property
end

#zip_output ⇒ Object

Gets or sets a value indicating whether to zip output or not. The default value is false. When set to true, output files will be zipped.



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

def zip_output
  @zip_output
end

Class Method Details

.attribute_map ⇒ Object

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



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

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_ambiguous_text_font' => :'UpdateAmbiguousTextFont',
    :'update_created_time_property' => :'UpdateCreatedTimeProperty',
    :'update_fields' => :'UpdateFields',
    :'update_last_printed_property' => :'UpdateLastPrintedProperty',
    :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty',
    :'zip_output' => :'ZipOutput',
    :'encoding' => :'Encoding',
    :'export_headers_footers_mode' => :'ExportHeadersFootersMode',
    :'force_page_breaks' => :'ForcePageBreaks',
    :'paragraph_break' => :'ParagraphBreak',
    :'add_bidi_marks' => :'AddBidiMarks',
    :'max_characters_per_line' => :'MaxCharactersPerLine',
    :'office_math_export_mode' => :'OfficeMathExportMode',
    :'preserve_table_layout' => :'PreserveTableLayout',
    :'simplify_list_labels' => :'SimplifyListLabels',
    :'save_format' => :'SaveFormat'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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_ambiguous_text_font' => :'BOOLEAN',
    :'update_created_time_property' => :'BOOLEAN',
    :'update_fields' => :'BOOLEAN',
    :'update_last_printed_property' => :'BOOLEAN',
    :'update_last_saved_time_property' => :'BOOLEAN',
    :'zip_output' => :'BOOLEAN',
    :'encoding' => :'String',
    :'export_headers_footers_mode' => :'String',
    :'force_page_breaks' => :'BOOLEAN',
    :'paragraph_break' => :'String',
    :'add_bidi_marks' => :'BOOLEAN',
    :'max_characters_per_line' => :'Integer',
    :'office_math_export_mode' => :'String',
    :'preserve_table_layout' => :'BOOLEAN',
    :'simplify_list_labels' => :'BOOLEAN',
    :'save_format' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 405

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_ambiguous_text_font == other.update_ambiguous_text_font &&
      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 &&
      zip_output == other.zip_output &&
      encoding == other.encoding &&
      export_headers_footers_mode == other.export_headers_footers_mode &&
      force_page_breaks == other.force_page_breaks &&
      paragraph_break == other.paragraph_break &&
      add_bidi_marks == other.add_bidi_marks &&
      max_characters_per_line == other.max_characters_per_line &&
      office_math_export_mode == other.office_math_export_mode &&
      preserve_table_layout == other.preserve_table_layout &&
      simplify_list_labels == other.simplify_list_labels &&
      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



470
471
472
473
474
475
476
477
478
479
480
481
482
483
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
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 470

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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    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



541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 541

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



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 448

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 



555
556
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 555

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


435
436
437
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 435

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



441
442
443
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 441

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_ambiguous_text_font, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, zip_output, encoding, export_headers_footers_mode, force_page_breaks, paragraph_break, add_bidi_marks, max_characters_per_line, office_math_export_mode, preserve_table_layout, simplify_list_labels, save_format].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



521
522
523
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 521

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



527
528
529
530
531
532
533
534
535
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 527

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



515
516
517
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 515

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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 301

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)
  export_headers_footers_mode_validator = EnumAttributeValidator.new('String', ["None", "PrimaryOnly", "AllAtEnd"])
  return false unless export_headers_footers_mode_validator.valid?(@export_headers_footers_mode)
  office_math_export_mode_validator = EnumAttributeValidator.new('String', ["Text", "Latex"])
  return false unless office_math_export_mode_validator.valid?(@office_math_export_mode)

  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


558
559
560
561
562
563
564
565
 
# File 'lib/aspose_words_cloud/models/text_save_options_data.rb', line 558

def validate()
  raise ArgumentError, 'Property file_name in TextSaveOptionsData is required.' if self.file_name.nil?
  raise ArgumentError, 'Property max_characters_per_line in TextSaveOptionsData is required.' if self.max_characters_per_line.nil?
  unless self.custom_time_zone_info_data.nil?
      self.custom_time_zone_info_data.validate
  end

end