Class: AsposeWordsCloud::StyleUpdate

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

Overview

Represents a single document style properties to update.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StyleUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 68

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

  if attributes.key?(:'BaseStyleName')
    self.base_style_name = attributes[:'BaseStyleName']
  end

  if attributes.key?(:'IsQuickStyle')
    self.is_quick_style = attributes[:'IsQuickStyle']
  end

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

Instance Attribute Details

#base_style_name ⇒ Object

Gets or sets the name of the style this style is based on. This will be an empty string if the style is not based on any other style and it can be set to an empty string.



38
39
40
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 38

def base_style_name
  @base_style_name
end

#is_quick_style ⇒ Object

Gets or sets a value indicating whether this style is shown in the Quick Style gallery inside MS Word UI.



41
42
43
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 41

def is_quick_style
  @is_quick_style
end

#name ⇒ Object

Gets or sets the name of the style. Can not be empty string. If there already is a style with such name in the collection, than this style will override it. All affected nodes will reference new style.



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

def name
  @name
end

#next_paragraph_style_name ⇒ Object

Gets or sets the name of the style to be applied automatically to a new paragraph inserted after a paragraph formatted with the specified style. This property is not used by Aspose.Words. The next paragraph style will only be applied automatically when you edit the document in MS Word.



34
35
36
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 34

def next_paragraph_style_name
  @next_paragraph_style_name
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 47

def self.attribute_map
  {
    :'next_paragraph_style_name' => :'NextParagraphStyleName',
    :'base_style_name' => :'BaseStyleName',
    :'is_quick_style' => :'IsQuickStyle',
    :'name' => :'Name'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 57

def self.swagger_types
  {
    :'next_paragraph_style_name' => :'String',
    :'base_style_name' => :'String',
    :'is_quick_style' => :'BOOLEAN',
    :'name' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



99
100
101
102
103
104
105
106
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 99

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      next_paragraph_style_name == other.next_paragraph_style_name &&
      base_style_name == other.base_style_name &&
      is_quick_style == other.is_quick_style &&
      name == other.name
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



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

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



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 216

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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 123

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 



230
231
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 230

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


110
111
112
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 110

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [next_paragraph_style_name, base_style_name, is_quick_style, name].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



196
197
198
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 196

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



202
203
204
205
206
207
208
209
210
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 202

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



190
191
192
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 190

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



93
94
95
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 93

def valid?
  return true
end

#validate ⇒ Object 



233
234
 
# File 'lib/aspose_words_cloud/models/style_update.rb', line 233

def validate()
end