Class: AsposeWordsCloud::TableCellFormat

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

Overview

DTO container with all formatting for a table row.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TableCellFormat

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
191
192
193
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 136

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

  if attributes.key?(:'BottomPadding')
    self.bottom_padding = attributes[:'BottomPadding']
  end

  if attributes.key?(:'FitText')
    self.fit_text = attributes[:'FitText']
  end

  if attributes.key?(:'HorizontalMerge')
    self.horizontal_merge = attributes[:'HorizontalMerge']
  end

  if attributes.key?(:'LeftPadding')
    self.left_padding = attributes[:'LeftPadding']
  end

  if attributes.key?(:'Orientation')
    self.orientation = attributes[:'Orientation']
  end

  if attributes.key?(:'PreferredWidth')
    self.preferred_width = attributes[:'PreferredWidth']
  end

  if attributes.key?(:'RightPadding')
    self.right_padding = attributes[:'RightPadding']
  end

  if attributes.key?(:'TopPadding')
    self.top_padding = attributes[:'TopPadding']
  end

  if attributes.key?(:'VerticalAlignment')
    self.vertical_alignment = attributes[:'VerticalAlignment']
  end

  if attributes.key?(:'VerticalMerge')
    self.vertical_merge = attributes[:'VerticalMerge']
  end

  if attributes.key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.key?(:'WrapText')
    self.wrap_text = attributes[:'WrapText']
  end
end

Instance Attribute Details

#bottom_padding ⇒ Object

Gets or sets the amount of space (in points) to add below the contents of the cell.



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

def bottom_padding
  @bottom_padding
end

#fit_text ⇒ Object

Gets or sets a value indicating whether to fit text in the cell, compress each paragraph to the width of the cell.



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

def fit_text
  @fit_text
end

#horizontal_merge ⇒ Object

Gets or sets the option that controls how the cell is merged horizontally with other cells in the row.



42
43
44
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 42

def horizontal_merge
  @horizontal_merge
end

#left_padding ⇒ Object

Gets or sets the amount of space (in points) to add to the left of the contents of the cell.



45
46
47
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 45

def left_padding
  @left_padding
end

#link ⇒ Object

Gets or sets the link to the document.



33
34
35
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 33

def link
  @link
end

#orientation ⇒ Object

Gets or sets the orientation of text in a table cell.



48
49
50
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 48

def orientation
  @orientation
end

#preferred_width ⇒ Object

Gets or sets the preferred width of the cell. The preferred width (along with the table’s Auto Fit option) determines how the actual width of the cell is calculated by the table layout algorithm. Table layout can be performed by Aspose.Words when it saves the document or by Microsoft Word when it displays the document.The preferred width can be specified in points or in percent. The preferred width can also be specified as “auto”, which means no preferred width is specified.The default value is Auto.



52
53
54
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 52

def preferred_width
  @preferred_width
end

#right_padding ⇒ Object

Gets or sets the amount of space (in points) to add to the right of the contents of the cell.



55
56
57
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 55

def right_padding
  @right_padding
end

#top_padding ⇒ Object

Gets or sets the amount of space (in points) to add above the contents of the cell.



58
59
60
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 58

def top_padding
  @top_padding
end

#vertical_alignment ⇒ Object

Gets or sets the vertical alignment of text in the cell.



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

def vertical_alignment
  @vertical_alignment
end

#vertical_merge ⇒ Object

Gets or sets the option that controls how the cell is merged with other cells vertically. Cells can only be merged vertically if their left and right boundaries are identical.When cells are vertically merged, the display areas of the merged cells are consolidated. The consolidated area is used to display the contents of the first vertically merged cell and all other vertically merged cells must be empty.



65
66
67
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 65

def vertical_merge
  @vertical_merge
end

#width ⇒ Object

Gets or sets the width of the cell in points. The width is calculated by Aspose.Words on document loading and saving. Currently, not every combination of table, cell and document properties is supported. The returned value may not be accurate for some documents. It may not exactly match the cell width as calculated by MS Word when the document is opened in MS Word.Setting this property is not recommended. There is no guarantee that the cell will actually have the set width. The width may be adjusted to accommodate cell contents in an auto-fit table layout. Cells in other rows may have conflicting width settings. The table may be resized to fit into the container or to meet table width settings. Consider using PreferredWidth for setting the cell width. Setting this property sets PreferredWidth implicitly since version 15.8.



69
70
71
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 69

def width
  @width
end

#wrap_text ⇒ Object

Gets or sets a value indicating whether to wrap text in the cell.



72
73
74
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 72

def wrap_text
  @wrap_text
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 97

def self.attribute_map
  {
    :'link' => :'Link',
    :'bottom_padding' => :'BottomPadding',
    :'fit_text' => :'FitText',
    :'horizontal_merge' => :'HorizontalMerge',
    :'left_padding' => :'LeftPadding',
    :'orientation' => :'Orientation',
    :'preferred_width' => :'PreferredWidth',
    :'right_padding' => :'RightPadding',
    :'top_padding' => :'TopPadding',
    :'vertical_alignment' => :'VerticalAlignment',
    :'vertical_merge' => :'VerticalMerge',
    :'width' => :'Width',
    :'wrap_text' => :'WrapText'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 116

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'bottom_padding' => :'Float',
    :'fit_text' => :'BOOLEAN',
    :'horizontal_merge' => :'String',
    :'left_padding' => :'Float',
    :'orientation' => :'String',
    :'preferred_width' => :'PreferredWidth',
    :'right_padding' => :'Float',
    :'top_padding' => :'Float',
    :'vertical_alignment' => :'String',
    :'vertical_merge' => :'String',
    :'width' => :'Float',
    :'wrap_text' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      link == other.link &&
      bottom_padding == other.bottom_padding &&
      fit_text == other.fit_text &&
      horizontal_merge == other.horizontal_merge &&
      left_padding == other.left_padding &&
      orientation == other.orientation &&
      preferred_width == other.preferred_width &&
      right_padding == other.right_padding &&
      top_padding == other.top_padding &&
      vertical_alignment == other.vertical_alignment &&
      vertical_merge == other.vertical_merge &&
      width == other.width &&
      wrap_text == other.wrap_text
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 324

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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 395

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



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

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 



409
410
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 409

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


289
290
291
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 289

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



295
296
297
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 295

def hash
  [link, bottom_padding, fit_text, horizontal_merge, left_padding, orientation, preferred_width, right_padding, top_padding, vertical_alignment, vertical_merge, width, wrap_text].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



375
376
377
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 375

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



381
382
383
384
385
386
387
388
389
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 381

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



369
370
371
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 369

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



197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 197

def valid?
  horizontal_merge_validator = EnumAttributeValidator.new('String', ["None", "First", "Previous"])
  return false unless horizontal_merge_validator.valid?(@horizontal_merge)
  orientation_validator = EnumAttributeValidator.new('String', ["Horizontal", "Downward", "Upward", "HorizontalRotatedFarEast", "VerticalFarEast", "VerticalRotatedFarEast"])
  return false unless orientation_validator.valid?(@orientation)
  vertical_alignment_validator = EnumAttributeValidator.new('String', ["Top", "Center", "Bottom"])
  return false unless vertical_alignment_validator.valid?(@vertical_alignment)
  vertical_merge_validator = EnumAttributeValidator.new('String', ["None", "First", "Previous"])
  return false unless vertical_merge_validator.valid?(@vertical_merge)

  return true
end

#validate ⇒ Object 



412
413
414
415
416
417
418
419
420
 
# File 'lib/aspose_words_cloud/models/table_cell_format.rb', line 412

def validate()
  unless self.link.nil?
      self.link.validate
  end
  unless self.preferred_width.nil?
      self.preferred_width.validate
  end

end