Class: AsposeWordsCloud::Font

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

Overview

DTO container with a font element.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Font

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
446
447
 
# File 'lib/aspose_words_cloud/models/font.rb', line 278

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

  if attributes.key?(:'Bidi')
    self.bidi = attributes[:'Bidi']
  end

  if attributes.key?(:'Bold')
    self.bold = attributes[:'Bold']
  end

  if attributes.key?(:'BoldBi')
    self.bold_bi = attributes[:'BoldBi']
  end

  if attributes.key?(:'Border')
    self.border = attributes[:'Border']
  end

  if attributes.key?(:'Color')
    self.color = attributes[:'Color']
  end

  if attributes.key?(:'ComplexScript')
    self.complex_script = attributes[:'ComplexScript']
  end

  if attributes.key?(:'DoubleStrikeThrough')
    self.double_strike_through = attributes[:'DoubleStrikeThrough']
  end

  if attributes.key?(:'Emboss')
    self.emboss = attributes[:'Emboss']
  end

  if attributes.key?(:'Engrave')
    self.engrave = attributes[:'Engrave']
  end

  if attributes.key?(:'Hidden')
    self.hidden = attributes[:'Hidden']
  end

  if attributes.key?(:'HighlightColor')
    self.highlight_color = attributes[:'HighlightColor']
  end

  if attributes.key?(:'Italic')
    self.italic = attributes[:'Italic']
  end

  if attributes.key?(:'ItalicBi')
    self.italic_bi = attributes[:'ItalicBi']
  end

  if attributes.key?(:'Kerning')
    self.kerning = attributes[:'Kerning']
  end

  if attributes.key?(:'LocaleId')
    self.locale_id = attributes[:'LocaleId']
  end

  if attributes.key?(:'LocaleIdBi')
    self.locale_id_bi = attributes[:'LocaleIdBi']
  end

  if attributes.key?(:'LocaleIdFarEast')
    self.locale_id_far_east = attributes[:'LocaleIdFarEast']
  end

  if attributes.key?(:'Name')
    self.name = attributes[:'Name']
  end

  if attributes.key?(:'NameAscii')
    self.name_ascii = attributes[:'NameAscii']
  end

  if attributes.key?(:'NameBi')
    self.name_bi = attributes[:'NameBi']
  end

  if attributes.key?(:'NameFarEast')
    self.name_far_east = attributes[:'NameFarEast']
  end

  if attributes.key?(:'NameOther')
    self.name_other = attributes[:'NameOther']
  end

  if attributes.key?(:'NoProofing')
    self.no_proofing = attributes[:'NoProofing']
  end

  if attributes.key?(:'Outline')
    self.outline = attributes[:'Outline']
  end

  if attributes.key?(:'Position')
    self.position = attributes[:'Position']
  end

  if attributes.key?(:'Scaling')
    self.scaling = attributes[:'Scaling']
  end

  if attributes.key?(:'Shadow')
    self.shadow = attributes[:'Shadow']
  end

  if attributes.key?(:'Size')
    self.size = attributes[:'Size']
  end

  if attributes.key?(:'SizeBi')
    self.size_bi = attributes[:'SizeBi']
  end

  if attributes.key?(:'SmallCaps')
    self.small_caps = attributes[:'SmallCaps']
  end

  if attributes.key?(:'Spacing')
    self.spacing = attributes[:'Spacing']
  end

  if attributes.key?(:'StrikeThrough')
    self.strike_through = attributes[:'StrikeThrough']
  end

  if attributes.key?(:'StyleIdentifier')
    self.style_identifier = attributes[:'StyleIdentifier']
  end

  if attributes.key?(:'StyleName')
    self.style_name = attributes[:'StyleName']
  end

  if attributes.key?(:'Subscript')
    self.subscript = attributes[:'Subscript']
  end

  if attributes.key?(:'Superscript')
    self.superscript = attributes[:'Superscript']
  end

  if attributes.key?(:'TextEffect')
    self.text_effect = attributes[:'TextEffect']
  end

  if attributes.key?(:'Underline')
    self.underline = attributes[:'Underline']
  end

  if attributes.key?(:'UnderlineColor')
    self.underline_color = attributes[:'UnderlineColor']
  end
end

Instance Attribute Details

#all_caps ⇒ Object

Gets or sets a value indicating whether the font is formatted as all capital letters.



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

def all_caps
  @all_caps
end

#bidi ⇒ Object

Gets or sets a value indicating whether the contents of this run shall have right-to-left characteristics. This property, when on, shall not be used with strongly left-to-right text. Any behavior under that condition is unspecified. This property, when off, shall not be used with strong right-to-left text. Any behavior under that condition is unspecified.When the contents of this run are displayed, all characters shall be treated as complex script characters for formatting purposes. This means that BoldBi, ItalicBi, SizeBi and a corresponding font name will be used when rendering this run.Also, when the contents of this run are displayed, this property acts as a right-to-left override for characters which are classified as “weak types” and “neutral types”.



40
41
42
 
# File 'lib/aspose_words_cloud/models/font.rb', line 40

def bidi
  @bidi
end

#bold ⇒ Object

Gets or sets a value indicating whether the font is formatted as bold.



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

def bold
  @bold
end

#bold_bi ⇒ Object

Gets or sets a value indicating whether the right-to-left text is formatted as bold.



46
47
48
 
# File 'lib/aspose_words_cloud/models/font.rb', line 46

def bold_bi
  @bold_bi
end

#border ⇒ Object

Gets or sets the border object, that specifies border for the font.



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

def border
  @border
end

#color ⇒ Object

Gets or sets the color of the font.



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

def color
  @color
end

#complex_script ⇒ Object

Gets or sets a value indicating whether the contents of this run shall be treated as complex script text regardless of their Unicode character values when determining the formatting for this run.



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

def complex_script
  @complex_script
end

#double_strike_through ⇒ Object

Gets or sets a value indicating whether the font is formatted as double strikethrough text.



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

def double_strike_through
  @double_strike_through
end

#emboss ⇒ Object

Gets or sets a value indicating whether the font is formatted as embossed.



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

def emboss
  @emboss
end

#engrave ⇒ Object

Gets or sets a value indicating whether the font is formatted as engraved.



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

def engrave
  @engrave
end

#hidden ⇒ Object

Gets or sets a value indicating whether the font is formatted as hidden text.



67
68
69
 
# File 'lib/aspose_words_cloud/models/font.rb', line 67

def hidden
  @hidden
end

#highlight_color ⇒ Object

Gets or sets the highlight (marker) color.



70
71
72
 
# File 'lib/aspose_words_cloud/models/font.rb', line 70

def highlight_color
  @highlight_color
end

#italic ⇒ Object

Gets or sets a value indicating whether the font is formatted as italic.



73
74
75
 
# File 'lib/aspose_words_cloud/models/font.rb', line 73

def italic
  @italic
end

#italic_bi ⇒ Object

Gets or sets a value indicating whether the right-to-left text is formatted as italic.



76
77
78
 
# File 'lib/aspose_words_cloud/models/font.rb', line 76

def italic_bi
  @italic_bi
end

#kerning ⇒ Object

Gets or sets the font size at which kerning starts.



79
80
81
 
# File 'lib/aspose_words_cloud/models/font.rb', line 79

def kerning
  @kerning
end

#link ⇒ Object

Gets or sets the link to the document.



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

def link
  @link
end

#locale_id ⇒ Object

Gets or sets the locale identifier (language) of the formatted characters. For the list of locale identifiers see www.microsoft.com/globaldev/reference/lcid-all.mspx.



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

def locale_id
  @locale_id
end

#locale_id_bi ⇒ Object

Gets or sets the locale identifier (language) of the formatted right-to-left characters. For the list of locale identifiers see www.microsoft.com/globaldev/reference/lcid-all.mspx.



87
88
89
 
# File 'lib/aspose_words_cloud/models/font.rb', line 87

def locale_id_bi
  @locale_id_bi
end

#locale_id_far_east ⇒ Object

Gets or sets the locale identifier (language) of the formatted Asian characters. For the list of locale identifiers see www.microsoft.com/globaldev/reference/lcid-all.mspx.



91
92
93
 
# File 'lib/aspose_words_cloud/models/font.rb', line 91

def locale_id_far_east
  @locale_id_far_east
end

#name ⇒ Object

Gets or sets the name of the font.



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

def name
  @name
end

#name_ascii ⇒ Object

Gets or sets the font used for Latin text (characters with character codes from 0 (zero) through 127).



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

def name_ascii
  @name_ascii
end

#name_bi ⇒ Object

Gets or sets the name of the font in a right-to-left language document.



100
101
102
 
# File 'lib/aspose_words_cloud/models/font.rb', line 100

def name_bi
  @name_bi
end

#name_far_east ⇒ Object

Gets or sets the East Asian font name.



103
104
105
 
# File 'lib/aspose_words_cloud/models/font.rb', line 103

def name_far_east
  @name_far_east
end

#name_other ⇒ Object

Gets or sets the font used for characters with character codes from 128 through 255.



106
107
108
 
# File 'lib/aspose_words_cloud/models/font.rb', line 106

def name_other
  @name_other
end

#no_proofing ⇒ Object

Gets or sets a value indicating whether the formatted characters are not to be spell checked.



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

def no_proofing
  @no_proofing
end

#outline ⇒ Object

Gets or sets a value indicating whether the font is formatted as outline.



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

def outline
  @outline
end

#position ⇒ Object

Gets or sets the position of text (in points) relative to the base line. A positive number raises the text, and a negative number lowers it.



116
117
118
 
# File 'lib/aspose_words_cloud/models/font.rb', line 116

def position
  @position
end

#scaling ⇒ Object

Gets or sets character width scaling in percent.



119
120
121
 
# File 'lib/aspose_words_cloud/models/font.rb', line 119

def scaling
  @scaling
end

#shadow ⇒ Object

Gets or sets a value indicating whether the font is formatted as shadowed.



122
123
124
 
# File 'lib/aspose_words_cloud/models/font.rb', line 122

def shadow
  @shadow
end

#size ⇒ Object

Gets or sets the font size in points.



125
126
127
 
# File 'lib/aspose_words_cloud/models/font.rb', line 125

def size
  @size
end

#size_bi ⇒ Object

Gets or sets the font size in points used in a right-to-left document.



128
129
130
 
# File 'lib/aspose_words_cloud/models/font.rb', line 128

def size_bi
  @size_bi
end

#small_caps ⇒ Object

Gets or sets a value indicating whether the font is formatted as small capital letters.



131
132
133
 
# File 'lib/aspose_words_cloud/models/font.rb', line 131

def small_caps
  @small_caps
end

#spacing ⇒ Object

Gets or sets the spacing (in points) between characters.



134
135
136
 
# File 'lib/aspose_words_cloud/models/font.rb', line 134

def spacing
  @spacing
end

#strike_through ⇒ Object

Gets or sets a value indicating whether the font is formatted as strikethrough text.



137
138
139
 
# File 'lib/aspose_words_cloud/models/font.rb', line 137

def strike_through
  @strike_through
end

#style_identifier ⇒ Object

Gets or sets the locale independent style identifier of the character style applied to this formatting.



140
141
142
 
# File 'lib/aspose_words_cloud/models/font.rb', line 140

def style_identifier
  @style_identifier
end

#style_name ⇒ Object

Gets or sets the name of the character style applied to this formatting.



143
144
145
 
# File 'lib/aspose_words_cloud/models/font.rb', line 143

def style_name
  @style_name
end

#subscript ⇒ Object

Gets or sets a value indicating whether the font is formatted as subscript.



146
147
148
 
# File 'lib/aspose_words_cloud/models/font.rb', line 146

def subscript
  @subscript
end

#superscript ⇒ Object

Gets or sets a value indicating whether the font is formatted as superscript.



149
150
151
 
# File 'lib/aspose_words_cloud/models/font.rb', line 149

def superscript
  @superscript
end

#text_effect ⇒ Object

Gets or sets the font animation effect.



152
153
154
 
# File 'lib/aspose_words_cloud/models/font.rb', line 152

def text_effect
  @text_effect
end

#underline ⇒ Object

Gets or sets the type of underline applied to the font.



155
156
157
 
# File 'lib/aspose_words_cloud/models/font.rb', line 155

def underline
  @underline
end

#underline_color ⇒ Object

Gets or sets the color of the underline applied to the font.



158
159
160
 
# File 'lib/aspose_words_cloud/models/font.rb', line 158

def underline_color
  @underline_color
end

Class Method Details

.attribute_map ⇒ Object

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



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/aspose_words_cloud/models/font.rb', line 183

def self.attribute_map
  {
    :'link' => :'Link',
    :'all_caps' => :'AllCaps',
    :'bidi' => :'Bidi',
    :'bold' => :'Bold',
    :'bold_bi' => :'BoldBi',
    :'border' => :'Border',
    :'color' => :'Color',
    :'complex_script' => :'ComplexScript',
    :'double_strike_through' => :'DoubleStrikeThrough',
    :'emboss' => :'Emboss',
    :'engrave' => :'Engrave',
    :'hidden' => :'Hidden',
    :'highlight_color' => :'HighlightColor',
    :'italic' => :'Italic',
    :'italic_bi' => :'ItalicBi',
    :'kerning' => :'Kerning',
    :'locale_id' => :'LocaleId',
    :'locale_id_bi' => :'LocaleIdBi',
    :'locale_id_far_east' => :'LocaleIdFarEast',
    :'name' => :'Name',
    :'name_ascii' => :'NameAscii',
    :'name_bi' => :'NameBi',
    :'name_far_east' => :'NameFarEast',
    :'name_other' => :'NameOther',
    :'no_proofing' => :'NoProofing',
    :'outline' => :'Outline',
    :'position' => :'Position',
    :'scaling' => :'Scaling',
    :'shadow' => :'Shadow',
    :'size' => :'Size',
    :'size_bi' => :'SizeBi',
    :'small_caps' => :'SmallCaps',
    :'spacing' => :'Spacing',
    :'strike_through' => :'StrikeThrough',
    :'style_identifier' => :'StyleIdentifier',
    :'style_name' => :'StyleName',
    :'subscript' => :'Subscript',
    :'superscript' => :'Superscript',
    :'text_effect' => :'TextEffect',
    :'underline' => :'Underline',
    :'underline_color' => :'UnderlineColor'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'all_caps' => :'BOOLEAN',
    :'bidi' => :'BOOLEAN',
    :'bold' => :'BOOLEAN',
    :'bold_bi' => :'BOOLEAN',
    :'border' => :'Border',
    :'color' => :'XmlColor',
    :'complex_script' => :'BOOLEAN',
    :'double_strike_through' => :'BOOLEAN',
    :'emboss' => :'BOOLEAN',
    :'engrave' => :'BOOLEAN',
    :'hidden' => :'BOOLEAN',
    :'highlight_color' => :'XmlColor',
    :'italic' => :'BOOLEAN',
    :'italic_bi' => :'BOOLEAN',
    :'kerning' => :'Float',
    :'locale_id' => :'Integer',
    :'locale_id_bi' => :'Integer',
    :'locale_id_far_east' => :'Integer',
    :'name' => :'String',
    :'name_ascii' => :'String',
    :'name_bi' => :'String',
    :'name_far_east' => :'String',
    :'name_other' => :'String',
    :'no_proofing' => :'BOOLEAN',
    :'outline' => :'BOOLEAN',
    :'position' => :'Float',
    :'scaling' => :'Integer',
    :'shadow' => :'BOOLEAN',
    :'size' => :'Float',
    :'size_bi' => :'Float',
    :'small_caps' => :'BOOLEAN',
    :'spacing' => :'Float',
    :'strike_through' => :'BOOLEAN',
    :'style_identifier' => :'String',
    :'style_name' => :'String',
    :'subscript' => :'BOOLEAN',
    :'superscript' => :'BOOLEAN',
    :'text_effect' => :'String',
    :'underline' => :'String',
    :'underline_color' => :'XmlColor'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/aspose_words_cloud/models/font.rb', line 507

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      link == other.link &&
      all_caps == other.all_caps &&
      bidi == other.bidi &&
      bold == other.bold &&
      bold_bi == other.bold_bi &&
      border == other.border &&
      color == other.color &&
      complex_script == other.complex_script &&
      double_strike_through == other.double_strike_through &&
      emboss == other.emboss &&
      engrave == other.engrave &&
      hidden == other.hidden &&
      highlight_color == other.highlight_color &&
      italic == other.italic &&
      italic_bi == other.italic_bi &&
      kerning == other.kerning &&
      locale_id == other.locale_id &&
      locale_id_bi == other.locale_id_bi &&
      locale_id_far_east == other.locale_id_far_east &&
      name == other.name &&
      name_ascii == other.name_ascii &&
      name_bi == other.name_bi &&
      name_far_east == other.name_far_east &&
      name_other == other.name_other &&
      no_proofing == other.no_proofing &&
      outline == other.outline &&
      position == other.position &&
      scaling == other.scaling &&
      shadow == other.shadow &&
      size == other.size &&
      size_bi == other.size_bi &&
      small_caps == other.small_caps &&
      spacing == other.spacing &&
      strike_through == other.strike_through &&
      style_identifier == other.style_identifier &&
      style_name == other.style_name &&
      subscript == other.subscript &&
      superscript == other.superscript &&
      text_effect == other.text_effect &&
      underline == other.underline &&
      underline_color == other.underline_color
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



590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/aspose_words_cloud/models/font.rb', line 590

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



661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/aspose_words_cloud/models/font.rb', line 661

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



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/aspose_words_cloud/models/font.rb', line 568

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 



675
676
 
# File 'lib/aspose_words_cloud/models/font.rb', line 675

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



561
562
563
 
# File 'lib/aspose_words_cloud/models/font.rb', line 561

def hash
  [link, all_caps, bidi, bold, bold_bi, border, color, complex_script, double_strike_through, emboss, engrave, hidden, highlight_color, italic, italic_bi, kerning, locale_id, locale_id_bi, locale_id_far_east, name, name_ascii, name_bi, name_far_east, name_other, no_proofing, outline, position, scaling, shadow, size, size_bi, small_caps, spacing, strike_through, style_identifier, style_name, subscript, superscript, text_effect, underline, underline_color].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



641
642
643
 
# File 'lib/aspose_words_cloud/models/font.rb', line 641

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



647
648
649
650
651
652
653
654
655
 
# File 'lib/aspose_words_cloud/models/font.rb', line 647

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



635
636
637
 
# File 'lib/aspose_words_cloud/models/font.rb', line 635

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



451
452
453
454
455
456
457
458
459
460
 
# File 'lib/aspose_words_cloud/models/font.rb', line 451

def valid?
  style_identifier_validator = EnumAttributeValidator.new('String', ["Normal", "Heading1", "Heading2", "Heading3", "Heading4", "Heading5", "Heading6", "Heading7", "Heading8", "Heading9", "Index1", "Index2", "Index3", "Index4", "Index5", "Index6", "Index7", "Index8", "Index9", "Toc1", "Toc2", "Toc3", "Toc4", "Toc5", "Toc6", "Toc7", "Toc8", "Toc9", "NormalIndent", "FootnoteText", "CommentText", "Header", "Footer", "IndexHeading", "Caption", "TableOfFigures", "EnvelopeAddress", "EnvelopeReturn", "FootnoteReference", "CommentReference", "LineNumber", "PageNumber", "EndnoteReference", "EndnoteText", "TableOfAuthorities", "Macro", "ToaHeading", "List", "ListBullet", "ListNumber", "List2", "List3", "List4", "List5", "ListBullet2", "ListBullet3", "ListBullet4", "ListBullet5", "ListNumber2", "ListNumber3", "ListNumber4", "ListNumber5", "Title", "Closing", "Signature", "DefaultParagraphFont", "BodyText", "BodyTextInd", "ListContinue", "ListContinue2", "ListContinue3", "ListContinue4", "ListContinue5", "MessageHeader", "Subtitle", "Salutation", "Date", "BodyText1I", "BodyText1I2", "NoteHeading", "BodyText2", "BodyText3", "BodyTextInd2", "BodyTextInd3", "BlockText", "Hyperlink", "FollowedHyperlink", "Strong", "Emphasis", "DocumentMap", "PlainText", "EmailSignature", "HtmlTopOfForm", "HtmlBottomOfForm", "NormalWeb", "HtmlAcronym", "HtmlAddress", "HtmlCite", "HtmlCode", "HtmlDefinition", "HtmlKeyboard", "HtmlPreformatted", "HtmlSample", "HtmlTypewriter", "HtmlVariable", "TableNormal", "CommentSubject", "NoList", "OutlineList1", "OutlineList2", "OutlineList3", "TableSimple1", "TableSimple2", "TableSimple3", "TableClassic1", "TableClassic2", "TableClassic3", "TableClassic4", "TableColorful1", "TableColorful2", "TableColorful3", "TableColumns1", "TableColumns2", "TableColumns3", "TableColumns4", "TableColumns5", "TableGrid1", "TableGrid2", "TableGrid3", "TableGrid4", "TableGrid5", "TableGrid6", "TableGrid7", "TableGrid8", "TableList1", "TableList2", "TableList3", "TableList4", "TableList5", "TableList6", "TableList7", "TableList8", "Table3DEffects1", "Table3DEffects2", "Table3DEffects3", "TableContemporary", "TableElegant", "TableProfessional", "TableSubtle1", "TableSubtle2", "TableWeb1", "TableWeb2", "TableWeb3", "BalloonText", "TableGrid", "TableTheme", "PlaceholderText", "NoSpacing", "LightShading", "LightList", "LightGrid", "MediumShading1", "MediumShading2", "MediumList1", "MediumList2", "MediumGrid1", "MediumGrid2", "MediumGrid3", "DarkList", "ColorfulShading", "ColorfulList", "ColorfulGrid", "LightShadingAccent1", "LightListAccent1", "LightGridAccent1", "MediumShading1Accent1", "MediumShading2Accent1", "MediumList1Accent1", "Revision", "ListParagraph", "Quote", "IntenseQuote", "MediumList2Accent1", "MediumGrid1Accent1", "MediumGrid2Accent1", "MediumGrid3Accent1", "DarkListAccent1", "ColorfulShadingAccent1", "ColorfulListAccent1", "ColorfulGridAccent1", "LightShadingAccent2", "LightListAccent2", "LightGridAccent2", "MediumShading1Accent2", "MediumShading2Accent2", "MediumList1Accent2", "MediumList2Accent2", "MediumGrid1Accent2", "MediumGrid2Accent2", "MediumGrid3Accent2", "DarkListAccent2", "ColorfulShadingAccent2", "ColorfulListAccent2", "ColorfulGridAccent2", "LightShadingAccent3", "LightListAccent3", "LightGridAccent3", "MediumShading1Accent3", "MediumShading2Accent3", "MediumList1Accent3", "MediumList2Accent3", "MediumGrid1Accent3", "MediumGrid2Accent3", "MediumGrid3Accent3", "DarkListAccent3", "ColorfulShadingAccent3", "ColorfulListAccent3", "ColorfulGridAccent3", "LightShadingAccent4", "LightListAccent4", "LightGridAccent4", "MediumShading1Accent4", "MediumShading2Accent4", "MediumList1Accent4", "MediumList2Accent4", "MediumGrid1Accent4", "MediumGrid2Accent4", "MediumGrid3Accent4", "DarkListAccent4", "ColorfulShadingAccent4", "ColorfulListAccent4", "ColorfulGridAccent4", "LightShadingAccent5", "LightListAccent5", "LightGridAccent5", "MediumShading1Accent5", "MediumShading2Accent5", "MediumList1Accent5", "MediumList2Accent5", "MediumGrid1Accent5", "MediumGrid2Accent5", "MediumGrid3Accent5", "DarkListAccent5", "ColorfulShadingAccent5", "ColorfulListAccent5", "ColorfulGridAccent5", "LightShadingAccent6", "LightListAccent6", "LightGridAccent6", "MediumShading1Accent6", "MediumShading2Accent6", "MediumList1Accent6", "MediumList2Accent6", "MediumGrid1Accent6", "MediumGrid2Accent6", "MediumGrid3Accent6", "DarkListAccent6", "ColorfulShadingAccent6", "ColorfulListAccent6", "ColorfulGridAccent6", "SubtleEmphasis", "IntenseEmphasis", "SubtleReference", "IntenseReference", "BookTitle", "Bibliography", "TocHeading", "PlainTable1", "PlainTable2", "PlainTable3", "PlainTable4", "PlainTable5", "TableGridLight", "GridTable1Light", "GridTable2", "GridTable3", "GridTable4", "GridTable5Dark", "GridTable6Colorful", "GridTable7Colorful", "GridTable1LightAccent1", "GridTable2Accent1", "GridTable3Accent1", "GridTable4Accent1", "GridTable5DarkAccent1", "GridTable6ColorfulAccent1", "GridTable7ColorfulAccent1", "GridTable1LightAccent2", "GridTable2Accent2", "GridTable3Accent2", "GridTable4Accent2", "GridTable5DarkAccent2", "GridTable6ColorfulAccent2", "GridTable7ColorfulAccent2", "GridTable1LightAccent3", "GridTable2Accent3", "GridTable3Accent3", "GridTable4Accent3", "GridTable5DarkAccent3", "GridTable6ColorfulAccent3", "GridTable7ColorfulAccent3", "GridTable1LightAccent4", "GridTable2Accent4", "GridTable3Accent4", "GridTable4Accent4", "GridTable5DarkAccent4", "GridTable6ColorfulAccent4", "GridTable7ColorfulAccent4", "GridTable1LightAccent5", "GridTable2Accent5", "GridTable3Accent5", "GridTable4Accent5", "GridTable5DarkAccent5", "GridTable6ColorfulAccent5", "GridTable7ColorfulAccent5", "GridTable1LightAccent6", "GridTable2Accent6", "GridTable3Accent6", "GridTable4Accent6", "GridTable5DarkAccent6", "GridTable6ColorfulAccent6", "GridTable7ColorfulAccent6", "ListTable1Light", "ListTable2", "ListTable3", "ListTable4", "ListTable5Dark", "ListTable6Colorful", "ListTable7Colorful", "ListTable1LightAccent1", "ListTable2Accent1", "ListTable3Accent1", "ListTable4Accent1", "ListTable5DarkAccent1", "ListTable6ColorfulAccent1", "ListTable7ColorfulAccent1", "ListTable1LightAccent2", "ListTable2Accent2", "ListTable3Accent2", "ListTable4Accent2", "ListTable5DarkAccent2", "ListTable6ColorfulAccent2", "ListTable7ColorfulAccent2", "ListTable1LightAccent3", "ListTable2Accent3", "ListTable3Accent3", "ListTable4Accent3", "ListTable5DarkAccent3", "ListTable6ColorfulAccent3", "ListTable7ColorfulAccent3", "ListTable1LightAccent4", "ListTable2Accent4", "ListTable3Accent4", "ListTable4Accent4", "ListTable5DarkAccent4", "ListTable6ColorfulAccent4", "ListTable7ColorfulAccent4", "ListTable1LightAccent5", "ListTable2Accent5", "ListTable3Accent5", "ListTable4Accent5", "ListTable5DarkAccent5", "ListTable6ColorfulAccent5", "ListTable7ColorfulAccent5", "ListTable1LightAccent6", "ListTable2Accent6", "ListTable3Accent6", "ListTable4Accent6", "ListTable5DarkAccent6", "ListTable6ColorfulAccent6", "ListTable7ColorfulAccent6", "SmartLink", "Mention", "SmartHyperlink", "Hashtag", "UnresolvedMention", "User", "Nil"])
  return false unless style_identifier_validator.valid?(@style_identifier)
  text_effect_validator = EnumAttributeValidator.new('String', ["None", "LasVegasLights", "BlinkingBackground", "SparkleText", "MarchingBlackAnts", "MarchingRedAnts", "Shimmer"])
  return false unless text_effect_validator.valid?(@text_effect)
  underline_validator = EnumAttributeValidator.new('String', ["None", "Single", "Words", "Double", "Dotted", "Thick", "Dash", "DotDash", "DotDotDash", "Wavy", "DottedHeavy", "DashHeavy", "DotDashHeavy", "DotDotDashHeavy", "WavyHeavy", "DashLong", "WavyDouble", "DashLongHeavy"])
  return false unless underline_validator.valid?(@underline)

  return true
end

#validate ⇒ Object 



678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/aspose_words_cloud/models/font.rb', line 678

def validate()
  unless self.link.nil?
      self.link.validate
  end
  unless self.border.nil?
      self.border.validate
  end
  unless self.color.nil?
      self.color.validate
  end
  unless self.highlight_color.nil?
      self.highlight_color.validate
  end
  unless self.underline_color.nil?
      self.underline_color.validate
  end

end