Class: GroupDocsConversionCloud::WordProcessingLoadOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb

Overview

WordProcessing document load options

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WordProcessingLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
331
332
333
334
335
336
337
338
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 214

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

  if attributes.key?(:'DefaultFont')
    self.default_font = attributes[:'DefaultFont']
  end

  if attributes.key?(:'FontSubstitutes')
    if (value = attributes[:'FontSubstitutes']).is_a?(Hash)
      self.font_substitutes = value
    end
  end

  if attributes.key?(:'Password')
    self.password = attributes[:'Password']
  end

  if attributes.key?(:'HideWordTrackedChanges')
    self.hide_word_tracked_changes = attributes[:'HideWordTrackedChanges']
  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?(:'ExpandedOutlineLevels')
    self.expanded_outline_levels = attributes[:'ExpandedOutlineLevels']
  end

  if attributes.key?(:'ClearCustomDocumentProperties')
    self.clear_custom_document_properties = attributes[:'ClearCustomDocumentProperties']
  end

  if attributes.key?(:'ClearBuiltInDocumentProperties')
    self.clear_built_in_document_properties = attributes[:'ClearBuiltInDocumentProperties']
  end

  if attributes.key?(:'Depth')
    self.depth = attributes[:'Depth']
  end

  if attributes.key?(:'ConvertOwned')
    self.convert_owned = attributes[:'ConvertOwned']
  end

  if attributes.key?(:'ConvertOwner')
    self.convert_owner = attributes[:'ConvertOwner']
  end

  if attributes.key?(:'AutoHyphenation')
    self.auto_hyphenation = attributes[:'AutoHyphenation']
  end

  if attributes.key?(:'HyphenateCaps')
    self.hyphenate_caps = attributes[:'HyphenateCaps']
  end

  if attributes.key?(:'PageNumbering')
    self.page_numbering = attributes[:'PageNumbering']
  end

  if attributes.key?(:'PreserveDocumentStructure')
    self.preserve_document_structure = attributes[:'PreserveDocumentStructure']
  end

  if attributes.key?(:'SkipExternalResources')
    self.skip_external_resources = attributes[:'SkipExternalResources']
  end

  if attributes.key?(:'UseTextShaper')
    self.use_text_shaper = attributes[:'UseTextShaper']
  end

  if attributes.key?(:'PreserveFormFields')
    self.preserve_form_fields = attributes[:'PreserveFormFields']
  end

  if attributes.key?(:'CommentDisplayMode')
    self.comment_display_mode = attributes[:'CommentDisplayMode']
  end

  if attributes.key?(:'KeepDateFieldOriginalValue')
    self.keep_date_field_original_value = attributes[:'KeepDateFieldOriginalValue']
  end

  if attributes.key?(:'UpdateFields')
    self.update_fields = attributes[:'UpdateFields']
  end

  if attributes.key?(:'UpdatePageLayout')
    self.update_page_layout = attributes[:'UpdatePageLayout']
  end

  if attributes.key?(:'EmbedTrueTypeFonts')
    self.embed_true_type_fonts = attributes[:'EmbedTrueTypeFonts']
  end

  if attributes.key?(:'FontInfoSubstitutionEnabled')
    self.font_info_substitution_enabled = attributes[:'FontInfoSubstitutionEnabled']
  end

  if attributes.key?(:'FontConfigSubstitutionEnabled')
    self.font_config_substitution_enabled = attributes[:'FontConfigSubstitutionEnabled']
  end

  if attributes.key?(:'FontNameSubstitutionEnabled')
    self.font_name_substitution_enabled = attributes[:'FontNameSubstitutionEnabled']
  end

  if attributes.key?(:'ShowFullCommenterName')
    self.show_full_commenter_name = attributes[:'ShowFullCommenterName']
  end

end

Instance Attribute Details

#auto_hyphenation ⇒ Object

Gets or sets value determining whether automatic hyphenation is turned on for the document. Default value for this property is false.



74
75
76
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 74

def auto_hyphenation
  @auto_hyphenation
end

#bookmarks_outline_level ⇒ Object

Specifies the default level in the document outline at which to display Word bookmarks. Default is 0. Valid range is 0 to 9.



50
51
52
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 50

def bookmarks_outline_level
  @bookmarks_outline_level
end

#clear_built_in_document_properties ⇒ Object

Clear built-in document properties. Default is false.



62
63
64
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 62

def clear_built_in_document_properties
  @clear_built_in_document_properties
end

#clear_custom_document_properties ⇒ Object

Clear custom document properties. Default is false.



59
60
61
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 59

def clear_custom_document_properties
  @clear_custom_document_properties
end

#comment_display_mode ⇒ Object

Specifies how comments should be displayed in the output document. Default is Balloon.



95
96
97
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 95

def comment_display_mode
  @comment_display_mode
end

#convert_owned ⇒ Object

Option to control whether the owned documents in the documents container must be converted



68
69
70
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 68

def convert_owned
  @convert_owned
end

#convert_owner ⇒ Object

Option to control whether the documents container itself must be converted If this property is true the documents container will be the first converted document. Default is true.



71
72
73
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 71

def convert_owner
  @convert_owner
end

#default_font ⇒ Object

Default font for Words document. The following font will be used if a font is missing.



38
39
40
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 38

def default_font
  @default_font
end

#depth ⇒ Object

Option to control how many levels in depth to perform conversion. Default: 1.



65
66
67
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 65

def depth
  @depth
end

#embed_true_type_fonts ⇒ Object

If EmbedTrueTypeFonts is true, GroupDocs.Conversion Cloud embed true type fonts in the output document. Default: true



107
108
109
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 107

def embed_true_type_fonts
  @embed_true_type_fonts
end

#expanded_outline_levels ⇒ Object

Specifies how many levels in the document outline to show expanded when the file is viewed. Default is 0. Valid range is 0 to 9. Note that this options will not work when saving to XPS.



56
57
58
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 56

def expanded_outline_levels
  @expanded_outline_levels
end

#font_config_substitution_enabled ⇒ Object

Automatically substitutes missing fonts based on FontConfig in the system. Default: false.



113
114
115
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 113

def font_config_substitution_enabled
  @font_config_substitution_enabled
end

#font_info_substitution_enabled ⇒ Object

Automatically substitutes missing fonts based on FontInfo in the document. Default: false.



110
111
112
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 110

def font_info_substitution_enabled
  @font_info_substitution_enabled
end

#font_name_substitution_enabled ⇒ Object

Automatically substitutes missing fonts based on the font name. Default: false.



116
117
118
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 116

def font_name_substitution_enabled
  @font_name_substitution_enabled
end

#font_substitutes ⇒ Object

Substitute specific fonts when converting Words document.



41
42
43
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 41

def font_substitutes
  @font_substitutes
end

#format ⇒ Object

The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.



35
36
37
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 35

def format
  @format
end

#headings_outline_levels ⇒ Object

Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. Default is 0. Valid range is 0 to 9.



53
54
55
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 53

def headings_outline_levels
  @headings_outline_levels
end

#hide_word_tracked_changes ⇒ Object

Hide markup and track changes for Word documents



47
48
49
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 47

def hide_word_tracked_changes
  @hide_word_tracked_changes
end

#hyphenate_caps ⇒ Object

Gets or sets value determining whether words written in all capital letters are hyphenated. Default value for this property is true.



77
78
79
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 77

def hyphenate_caps
  @hyphenate_caps
end

#keep_date_field_original_value ⇒ Object

Keep original value of date field. Default: false



98
99
100
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 98

def keep_date_field_original_value
  @keep_date_field_original_value
end

#page_numbering ⇒ Object

Enable or disable generation of page numbering in converted document. Default: false



80
81
82
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 80

def page_numbering
  @page_numbering
end

#password ⇒ Object

Set password to unprotect protected document



44
45
46
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 44

def password
  @password
end

#preserve_document_structure ⇒ Object

Determines whether the document structure should be preserved when converting to PDF (default is false).



83
84
85
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 83

def preserve_document_structure
  @preserve_document_structure
end

#preserve_form_fields ⇒ Object

Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.



92
93
94
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 92

def preserve_form_fields
  @preserve_form_fields
end

#show_full_commenter_name ⇒ Object

Show full commenter name in comments. Default is false.



119
120
121
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 119

def show_full_commenter_name
  @show_full_commenter_name
end

#skip_external_resources ⇒ Object

If true all external resource will not be loading. Default is true.



86
87
88
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 86

def skip_external_resources
  @skip_external_resources
end

#update_fields ⇒ Object

Update fields after loading. Default: false



101
102
103
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 101

def update_fields
  @update_fields
end

#update_page_layout ⇒ Object

Update page layout after loading. Default: false



104
105
106
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 104

def update_page_layout
  @update_page_layout
end

#use_text_shaper ⇒ Object

Specifies whether to use a text shaper for better kerning display. Default is false.



89
90
91
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 89

def use_text_shaper
  @use_text_shaper
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
170
171
172
173
174
175
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 143

def self.attribute_map
  {
    :'format' => :'Format',
    :'default_font' => :'DefaultFont',
    :'font_substitutes' => :'FontSubstitutes',
    :'password' => :'Password',
    :'hide_word_tracked_changes' => :'HideWordTrackedChanges',
    :'bookmarks_outline_level' => :'BookmarksOutlineLevel',
    :'headings_outline_levels' => :'HeadingsOutlineLevels',
    :'expanded_outline_levels' => :'ExpandedOutlineLevels',
    :'clear_custom_document_properties' => :'ClearCustomDocumentProperties',
    :'clear_built_in_document_properties' => :'ClearBuiltInDocumentProperties',
    :'depth' => :'Depth',
    :'convert_owned' => :'ConvertOwned',
    :'convert_owner' => :'ConvertOwner',
    :'auto_hyphenation' => :'AutoHyphenation',
    :'hyphenate_caps' => :'HyphenateCaps',
    :'page_numbering' => :'PageNumbering',
    :'preserve_document_structure' => :'PreserveDocumentStructure',
    :'skip_external_resources' => :'SkipExternalResources',
    :'use_text_shaper' => :'UseTextShaper',
    :'preserve_form_fields' => :'PreserveFormFields',
    :'comment_display_mode' => :'CommentDisplayMode',
    :'keep_date_field_original_value' => :'KeepDateFieldOriginalValue',
    :'update_fields' => :'UpdateFields',
    :'update_page_layout' => :'UpdatePageLayout',
    :'embed_true_type_fonts' => :'EmbedTrueTypeFonts',
    :'font_info_substitution_enabled' => :'FontInfoSubstitutionEnabled',
    :'font_config_substitution_enabled' => :'FontConfigSubstitutionEnabled',
    :'font_name_substitution_enabled' => :'FontNameSubstitutionEnabled',
    :'show_full_commenter_name' => :'ShowFullCommenterName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 178

def self.swagger_types
  {
    :'format' => :'String',
    :'default_font' => :'String',
    :'font_substitutes' => :'Hash<String, String>',
    :'password' => :'String',
    :'hide_word_tracked_changes' => :'BOOLEAN',
    :'bookmarks_outline_level' => :'Integer',
    :'headings_outline_levels' => :'Integer',
    :'expanded_outline_levels' => :'Integer',
    :'clear_custom_document_properties' => :'BOOLEAN',
    :'clear_built_in_document_properties' => :'BOOLEAN',
    :'depth' => :'Integer',
    :'convert_owned' => :'BOOLEAN',
    :'convert_owner' => :'BOOLEAN',
    :'auto_hyphenation' => :'BOOLEAN',
    :'hyphenate_caps' => :'BOOLEAN',
    :'page_numbering' => :'BOOLEAN',
    :'preserve_document_structure' => :'BOOLEAN',
    :'skip_external_resources' => :'BOOLEAN',
    :'use_text_shaper' => :'BOOLEAN',
    :'preserve_form_fields' => :'BOOLEAN',
    :'comment_display_mode' => :'String',
    :'keep_date_field_original_value' => :'BOOLEAN',
    :'update_fields' => :'BOOLEAN',
    :'update_page_layout' => :'BOOLEAN',
    :'embed_true_type_fonts' => :'BOOLEAN',
    :'font_info_substitution_enabled' => :'BOOLEAN',
    :'font_config_substitution_enabled' => :'BOOLEAN',
    :'font_name_substitution_enabled' => :'BOOLEAN',
    :'show_full_commenter_name' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 496

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      format == other.format &&
      default_font == other.default_font &&
      font_substitutes == other.font_substitutes &&
      password == other.password &&
      hide_word_tracked_changes == other.hide_word_tracked_changes &&
      bookmarks_outline_level == other.bookmarks_outline_level &&
      headings_outline_levels == other.headings_outline_levels &&
      expanded_outline_levels == other.expanded_outline_levels &&
      clear_custom_document_properties == other.clear_custom_document_properties &&
      clear_built_in_document_properties == other.clear_built_in_document_properties &&
      depth == other.depth &&
      convert_owned == other.convert_owned &&
      convert_owner == other.convert_owner &&
      auto_hyphenation == other.auto_hyphenation &&
      hyphenate_caps == other.hyphenate_caps &&
      page_numbering == other.page_numbering &&
      preserve_document_structure == other.preserve_document_structure &&
      skip_external_resources == other.skip_external_resources &&
      use_text_shaper == other.use_text_shaper &&
      preserve_form_fields == other.preserve_form_fields &&
      comment_display_mode == other.comment_display_mode &&
      keep_date_field_original_value == other.keep_date_field_original_value &&
      update_fields == other.update_fields &&
      update_page_layout == other.update_page_layout &&
      embed_true_type_fonts == other.embed_true_type_fonts &&
      font_info_substitution_enabled == other.font_info_substitution_enabled &&
      font_config_substitution_enabled == other.font_config_substitution_enabled &&
      font_name_substitution_enabled == other.font_name_substitution_enabled &&
      show_full_commenter_name == other.show_full_commenter_name
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



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 575

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.parse value
  when :Date
    Date.parse value
  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 = GroupDocsConversionCloud.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



642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 642

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



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 551

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    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


532
533
534
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 532

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



538
539
540
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 538

def hash
  [format, default_font, font_substitutes, password, hide_word_tracked_changes, bookmarks_outline_level, headings_outline_levels, expanded_outline_levels, clear_custom_document_properties, clear_built_in_document_properties, depth, convert_owned, convert_owner, auto_hyphenation, hyphenate_caps, page_numbering, preserve_document_structure, skip_external_resources, use_text_shaper, preserve_form_fields, comment_display_mode, keep_date_field_original_value, update_fields, update_page_layout, embed_true_type_fonts, font_info_substitution_enabled, font_config_substitution_enabled, font_name_substitution_enabled, show_full_commenter_name].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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 342

def list_invalid_properties
  invalid_properties = []
  if @hide_word_tracked_changes.nil?
    invalid_properties.push("invalid value for 'hide_word_tracked_changes', hide_word_tracked_changes cannot be nil.")
  end

  if @bookmarks_outline_level.nil?
    invalid_properties.push("invalid value for 'bookmarks_outline_level', bookmarks_outline_level cannot be nil.")
  end

  if @headings_outline_levels.nil?
    invalid_properties.push("invalid value for 'headings_outline_levels', headings_outline_levels cannot be nil.")
  end

  if @expanded_outline_levels.nil?
    invalid_properties.push("invalid value for 'expanded_outline_levels', expanded_outline_levels cannot be nil.")
  end

  if @clear_custom_document_properties.nil?
    invalid_properties.push("invalid value for 'clear_custom_document_properties', clear_custom_document_properties cannot be nil.")
  end

  if @clear_built_in_document_properties.nil?
    invalid_properties.push("invalid value for 'clear_built_in_document_properties', clear_built_in_document_properties cannot be nil.")
  end

  if @depth.nil?
    invalid_properties.push("invalid value for 'depth', depth cannot be nil.")
  end

  if @convert_owned.nil?
    invalid_properties.push("invalid value for 'convert_owned', convert_owned cannot be nil.")
  end

  if @convert_owner.nil?
    invalid_properties.push("invalid value for 'convert_owner', convert_owner cannot be nil.")
  end

  if @auto_hyphenation.nil?
    invalid_properties.push("invalid value for 'auto_hyphenation', auto_hyphenation cannot be nil.")
  end

  if @hyphenate_caps.nil?
    invalid_properties.push("invalid value for 'hyphenate_caps', hyphenate_caps cannot be nil.")
  end

  if @page_numbering.nil?
    invalid_properties.push("invalid value for 'page_numbering', page_numbering cannot be nil.")
  end

  if @preserve_document_structure.nil?
    invalid_properties.push("invalid value for 'preserve_document_structure', preserve_document_structure cannot be nil.")
  end

  if @skip_external_resources.nil?
    invalid_properties.push("invalid value for 'skip_external_resources', skip_external_resources cannot be nil.")
  end

  if @use_text_shaper.nil?
    invalid_properties.push("invalid value for 'use_text_shaper', use_text_shaper cannot be nil.")
  end

  if @preserve_form_fields.nil?
    invalid_properties.push("invalid value for 'preserve_form_fields', preserve_form_fields cannot be nil.")
  end

  if @comment_display_mode.nil?
    invalid_properties.push("invalid value for 'comment_display_mode', comment_display_mode cannot be nil.")
  end

  if @keep_date_field_original_value.nil?
    invalid_properties.push("invalid value for 'keep_date_field_original_value', keep_date_field_original_value cannot be nil.")
  end

  if @update_fields.nil?
    invalid_properties.push("invalid value for 'update_fields', update_fields cannot be nil.")
  end

  if @update_page_layout.nil?
    invalid_properties.push("invalid value for 'update_page_layout', update_page_layout cannot be nil.")
  end

  if @embed_true_type_fonts.nil?
    invalid_properties.push("invalid value for 'embed_true_type_fonts', embed_true_type_fonts cannot be nil.")
  end

  if @font_info_substitution_enabled.nil?
    invalid_properties.push("invalid value for 'font_info_substitution_enabled', font_info_substitution_enabled cannot be nil.")
  end

  if @font_config_substitution_enabled.nil?
    invalid_properties.push("invalid value for 'font_config_substitution_enabled', font_config_substitution_enabled cannot be nil.")
  end

  if @font_name_substitution_enabled.nil?
    invalid_properties.push("invalid value for 'font_name_substitution_enabled', font_name_substitution_enabled cannot be nil.")
  end

  if @show_full_commenter_name.nil?
    invalid_properties.push("invalid value for 'show_full_commenter_name', show_full_commenter_name cannot be nil.")
  end

  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



622
623
624
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 622

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



628
629
630
631
632
633
634
635
636
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 628

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



616
617
618
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 616

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



544
545
546
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 544

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/groupdocs_conversion_cloud/models/word_processing_load_options.rb', line 449

def valid?
  return false if @hide_word_tracked_changes.nil?
  return false if @bookmarks_outline_level.nil?
  return false if @headings_outline_levels.nil?
  return false if @expanded_outline_levels.nil?
  return false if @clear_custom_document_properties.nil?
  return false if @clear_built_in_document_properties.nil?
  return false if @depth.nil?
  return false if @convert_owned.nil?
  return false if @convert_owner.nil?
  return false if @auto_hyphenation.nil?
  return false if @hyphenate_caps.nil?
  return false if @page_numbering.nil?
  return false if @preserve_document_structure.nil?
  return false if @skip_external_resources.nil?
  return false if @use_text_shaper.nil?
  return false if @preserve_form_fields.nil?
  return false if @comment_display_mode.nil?
  comment_display_mode_validator = EnumAttributeValidator.new('String', ["Hidden", "Balloon", "Annotation"])
  return false unless comment_display_mode_validator.valid?(@comment_display_mode)
  return false if @keep_date_field_original_value.nil?
  return false if @update_fields.nil?
  return false if @update_page_layout.nil?
  return false if @embed_true_type_fonts.nil?
  return false if @font_info_substitution_enabled.nil?
  return false if @font_config_substitution_enabled.nil?
  return false if @font_name_substitution_enabled.nil?
  return false if @show_full_commenter_name.nil?
  return true
end