Class: AsposeWordsCloud::WatermarkDataText

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

Overview

Class for insert watermark text request building.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WatermarkDataText

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'FontFamily')
    self.font_family = attributes[:'FontFamily']
  end

  if attributes.key?(:'FontSize')
    self.font_size = attributes[:'FontSize']
  end

  if attributes.key?(:'IsSemitrasparent')
    self.is_semitrasparent = attributes[:'IsSemitrasparent']
  end

  if attributes.key?(:'Layout')
    self.layout = attributes[:'Layout']
  end

  if attributes.key?(:'Text')
    self.text = attributes[:'Text']
  end
end

Instance Attribute Details

#color ⇒ Object

Gets or sets font color. The default value is System.Drawing.Color.Silver.



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

def color
  @color
end

#font_family ⇒ Object

Gets or sets font family name. The default value is “Calibri”.



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

def font_family
  @font_family
end

#font_size ⇒ Object

Gets or sets a font size. The default value is 0 - auto. Valid values range from 0 to 65.5 inclusive. Auto font size means that the watermark will be scaled to its max width and max height relative to the page margins.



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

def font_size
  @font_size
end

#is_semitrasparent ⇒ Object

Gets or sets a boolean value which is responsible for opacity of the watermark. The default value is true.



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

def is_semitrasparent
  @is_semitrasparent
end

#layout ⇒ Object

Gets or sets layout of the watermark. The default value is Aspose.Words.WatermarkLayout.Diagonal.



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

def layout
  @layout
end

#text ⇒ Object

Gets or sets the watermark text.



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

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 74

def self.attribute_map
  {
    :'color' => :'Color',
    :'font_family' => :'FontFamily',
    :'font_size' => :'FontSize',
    :'is_semitrasparent' => :'IsSemitrasparent',
    :'layout' => :'Layout',
    :'text' => :'Text'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 86

def self.swagger_types
  {
    :'color' => :'XmlColor',
    :'font_family' => :'String',
    :'font_size' => :'Float',
    :'is_semitrasparent' => :'BOOLEAN',
    :'layout' => :'String',
    :'text' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 156

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      color == other.color &&
      font_family == other.font_family &&
      font_size == other.font_size &&
      is_semitrasparent == other.is_semitrasparent &&
      layout == other.layout &&
      text == other.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



204
205
206
207
208
209
210
211
212
213
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
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 204

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 275

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 182

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 



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

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


169
170
171
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 169

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



175
176
177
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 175

def hash
  [color, font_family, font_size, is_semitrasparent, layout, 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



255
256
257
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 255

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



261
262
263
264
265
266
267
268
269
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 261

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



249
250
251
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 249

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



132
133
134
135
136
137
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 132

def valid?
  layout_validator = EnumAttributeValidator.new('String', ["Horizontal", "Diagonal"])
  return false unless layout_validator.valid?(@layout)

  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


292
293
294
295
296
297
298
 
# File 'lib/aspose_words_cloud/models/watermark_data_text.rb', line 292

def validate()
  raise ArgumentError, 'Property text in WatermarkDataText is required.' if self.text.nil?
  unless self.color.nil?
      self.color.validate
  end

end