Class: GroupDocsConversionCloud::DocmLoadOptions

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

Overview

Docm load options

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocmLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
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
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 98

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?(:'AutoFontSubstitution')
    self.auto_font_substitution = attributes[:'AutoFontSubstitution']
  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?(:'HideComments')
    self.hide_comments = attributes[:'HideComments']
  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

end

Instance Attribute Details

#auto_font_substitution ⇒ Object

If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. If AutoFontSubstitution is enabled, GroupDocs.Conversion evaluates all the related fields in FontInfo (Panose, Sig etc) for the missing font and finds the closest match among the available font sources. Note that font substitution mechanism will override the DefaultFont in cases when FontInfo for the missing font is available in the document. The default value is True.



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

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



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

def bookmarks_outline_level
  @bookmarks_outline_level
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/docm_load_options.rb', line 38

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



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

def expanded_outline_levels
  @expanded_outline_levels
end

#font_substitutes ⇒ Object

Substitute specific fonts when converting Words document.



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

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/docm_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.



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

def headings_outline_levels
  @headings_outline_levels
end

#hide_comments ⇒ Object

Hide comments



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

def hide_comments
  @hide_comments
end

#hide_word_tracked_changes ⇒ Object

Hide markup and track changes for Word documents



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

def hide_word_tracked_changes
  @hide_word_tracked_changes
end

#password ⇒ Object

Set password to unprotect protected document



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

def password
  @password
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 65

def self.attribute_map
  {
    :'format' => :'Format',
    :'default_font' => :'DefaultFont',
    :'auto_font_substitution' => :'AutoFontSubstitution',
    :'font_substitutes' => :'FontSubstitutes',
    :'password' => :'Password',
    :'hide_word_tracked_changes' => :'HideWordTrackedChanges',
    :'hide_comments' => :'HideComments',
    :'bookmarks_outline_level' => :'BookmarksOutlineLevel',
    :'headings_outline_levels' => :'HeadingsOutlineLevels',
    :'expanded_outline_levels' => :'ExpandedOutlineLevels'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 81

def self.swagger_types
  {
    :'format' => :'String',
    :'default_font' => :'String',
    :'auto_font_substitution' => :'BOOLEAN',
    :'font_substitutes' => :'Hash<String, String>',
    :'password' => :'String',
    :'hide_word_tracked_changes' => :'BOOLEAN',
    :'hide_comments' => :'BOOLEAN',
    :'bookmarks_outline_level' => :'Integer',
    :'headings_outline_levels' => :'Integer',
    :'expanded_outline_levels' => :'Integer'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 193

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      format == other.format &&
      default_font == other.default_font &&
      auto_font_substitution == other.auto_font_substitution &&
      font_substitutes == other.font_substitutes &&
      password == other.password &&
      hide_word_tracked_changes == other.hide_word_tracked_changes &&
      hide_comments == other.hide_comments &&
      bookmarks_outline_level == other.bookmarks_outline_level &&
      headings_outline_levels == other.headings_outline_levels &&
      expanded_outline_levels == other.expanded_outline_levels
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



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

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 320

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 229

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


210
211
212
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 210

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 216

def hash
  [format, default_font, auto_font_substitution, font_substitutes, password, hide_word_tracked_changes, hide_comments, bookmarks_outline_level, headings_outline_levels, expanded_outline_levels].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



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

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

  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 @hide_comments.nil?
    invalid_properties.push("invalid value for 'hide_comments', hide_comments 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

  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



300
301
302
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 300

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



306
307
308
309
310
311
312
313
314
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 306

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



294
295
296
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 294

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



222
223
224
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 222

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



181
182
183
184
185
186
187
188
189
 
# File 'lib/groupdocs_conversion_cloud/models/docm_load_options.rb', line 181

def valid?
  return false if @auto_font_substitution.nil?
  return false if @hide_word_tracked_changes.nil?
  return false if @hide_comments.nil?
  return false if @bookmarks_outline_level.nil?
  return false if @headings_outline_levels.nil?
  return false if @expanded_outline_levels.nil?
  return true
end