Class: GroupDocsViewerCloud::WordProcessingOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_viewer_cloud/models/word_processing_options.rb

Overview

Provides options for rendering word processing documents

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WordProcessingOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 114

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

  if attributes.key?(:'LeftMargin')
    self.left_margin = attributes[:'LeftMargin']
  end

  if attributes.key?(:'RightMargin')
    self.right_margin = attributes[:'RightMargin']
  end

  if attributes.key?(:'TopMargin')
    self.top_margin = attributes[:'TopMargin']
  end

  if attributes.key?(:'BottomMargin')
    self.bottom_margin = attributes[:'BottomMargin']
  end

  if attributes.key?(:'PageSize')
    self.page_size = attributes[:'PageSize']
  end

  if attributes.key?(:'EnableOpenTypeFeatures')
    self.enable_open_type_features = attributes[:'EnableOpenTypeFeatures']
  end

  if attributes.key?(:'UnlinkTableOfContents')
    self.unlink_table_of_contents = attributes[:'UnlinkTableOfContents']
  end

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

end

Instance Attribute Details

#bottom_margin ⇒ Object

Bottom page margin (for HTML rendering only)



47
48
49
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 47

def bottom_margin
  @bottom_margin
end

#enable_open_type_features ⇒ Object

This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian Latin-based, or Cyrillic-based scripts.



53
54
55
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 53

def enable_open_type_features
  @enable_open_type_features
end

#left_margin ⇒ Object

Left page margin (for HTML rendering only)



38
39
40
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 38

def left_margin
  @left_margin
end

#page_size ⇒ Object

The size of the page.



50
51
52
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 50

def page_size
  @page_size
end

#render_tracked_changes ⇒ Object

Enables tracked changes (revisions) rendering



35
36
37
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 35

def render_tracked_changes
  @render_tracked_changes
end

#right_margin ⇒ Object

Right page margin (for HTML rendering only)



41
42
43
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 41

def right_margin
  @right_margin
end

#top_margin ⇒ Object

Top page margin (for HTML rendering only)



44
45
46
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 44

def top_margin
  @top_margin
end

#unlink_table_of_contents ⇒ Object

When rendering to HTML or PDF, you can set this option to ‘true` to disable navigation from the table of contents. For HTML rendering, `a` tags with relative links will be replaced with `span` tags, removing functionality but preserving visual appearance. For PDF rendering, the table of contents will be rendered as plain text without links to document sections.



56
57
58
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 56

def unlink_table_of_contents
  @unlink_table_of_contents
end

#update_fields ⇒ Object

Determines if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. Default value for this property is true — fields will be updated before saving.



59
60
61
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 59

def update_fields
  @update_fields
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 83

def self.attribute_map
  {
    :'render_tracked_changes' => :'RenderTrackedChanges',
    :'left_margin' => :'LeftMargin',
    :'right_margin' => :'RightMargin',
    :'top_margin' => :'TopMargin',
    :'bottom_margin' => :'BottomMargin',
    :'page_size' => :'PageSize',
    :'enable_open_type_features' => :'EnableOpenTypeFeatures',
    :'unlink_table_of_contents' => :'UnlinkTableOfContents',
    :'update_fields' => :'UpdateFields'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 98

def self.swagger_types
  {
    :'render_tracked_changes' => :'BOOLEAN',
    :'left_margin' => :'Float',
    :'right_margin' => :'Float',
    :'top_margin' => :'Float',
    :'bottom_margin' => :'Float',
    :'page_size' => :'String',
    :'enable_open_type_features' => :'BOOLEAN',
    :'unlink_table_of_contents' => :'BOOLEAN',
    :'update_fields' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 234

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      render_tracked_changes == other.render_tracked_changes &&
      left_margin == other.left_margin &&
      right_margin == other.right_margin &&
      top_margin == other.top_margin &&
      bottom_margin == other.bottom_margin &&
      page_size == other.page_size &&
      enable_open_type_features == other.enable_open_type_features &&
      unlink_table_of_contents == other.unlink_table_of_contents &&
      update_fields == other.update_fields
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/groupdocs_viewer_cloud/models/word_processing_options.rb', line 293

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 = GroupDocsViewerCloud.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/groupdocs_viewer_cloud/models/word_processing_options.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



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

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


250
251
252
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 250

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



256
257
258
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 256

def hash
  [render_tracked_changes, left_margin, right_margin, top_margin, bottom_margin, page_size, enable_open_type_features, unlink_table_of_contents, update_fields].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



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
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 160

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

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

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

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

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

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

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

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

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



340
341
342
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.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/groupdocs_viewer_cloud/models/word_processing_options.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/groupdocs_viewer_cloud/models/word_processing_options.rb', line 334

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



262
263
264
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 262

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/groupdocs_viewer_cloud/models/word_processing_options.rb', line 203

def valid?
  return false if @render_tracked_changes.nil?
  return false if @left_margin.nil?
  return false if @right_margin.nil?
  return false if @top_margin.nil?
  return false if @bottom_margin.nil?
  return false if @page_size.nil?
  page_size_validator = EnumAttributeValidator.new('String', ["Unspecified", "Letter", "Ledger", "A0", "A1", "A2", "A3", "A4"])
  return false unless page_size_validator.valid?(@page_size)
  return false if @enable_open_type_features.nil?
  return false if @unlink_table_of_contents.nil?
  return false if @update_fields.nil?
  return true
end