Class: AsposeWordsCloud::ListInfo

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

Overview

DTO container with a single document list.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
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
129
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 92

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

  if attributes.key?(:'IsMultiLevel')
    self.is_multi_level = attributes[:'IsMultiLevel']
  end

  if attributes.key?(:'IsRestartAtEachSection')
    self.is_restart_at_each_section = attributes[:'IsRestartAtEachSection']
  end

  if attributes.key?(:'IsListStyleDefinition')
    self.is_list_style_definition = attributes[:'IsListStyleDefinition']
  end

  if attributes.key?(:'IsListStyleReference')
    self.is_list_style_reference = attributes[:'IsListStyleReference']
  end

  if attributes.key?(:'Style')
    self.style = attributes[:'Style']
  end

  if attributes.key?(:'ListLevels')
    self.list_levels = attributes[:'ListLevels']
  end
end

Instance Attribute Details

#is_list_style_definition ⇒ Object

Gets or sets a value indicating whether this list is a definition of a list style. When this property is true, the Aspose.Words.Lists.List.Style property returns the list style that this list defines. By modifying properties of a list that defines a list style, you modify The properties of the list style. A list that is a definition of a list style cannot be applied directly to paragraphs to make them numbered. Aspose.Words.Lists.List.Style Aspose.Words.Lists.List.IsListStyleReference.



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

def is_list_style_definition
  @is_list_style_definition
end

#is_list_style_reference ⇒ Object

Gets or sets a value indicating whether this list is a reference to a list style. Note, modifying properties of a list that is a reference to list style has no effect. The list formatting specified in the list style itself always takes precedence. Aspose.Words.Lists.List.Style Aspose.Words.Lists.List.IsListStyleDefinition.



53
54
55
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 53

def is_list_style_reference
  @is_list_style_reference
end

#is_multi_level ⇒ Object

Gets or sets a value indicating whether the list contains 9 levels; false when 1 level. The lists that you create with Aspose.Words are always multi-level lists and contain 9 levels. Microsoft Word 2003 and later always create multi-level lists with 9 levels. But in some documents, created with earlier versions of Microsoft Word you might encounter lists that have 1 level only.



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

def is_multi_level
  @is_multi_level
end

#is_restart_at_each_section ⇒ Object

Gets or sets a value indicating whether list should be restarted at each section. The default value is false. This option is supported only in RTF, DOC and DOCX document formats. This option will be written to DOCX only if Aspose.Words.Saving.OoxmlCompliance is higher then Aspose.Words.Saving.OoxmlCompliance.Ecma376_2006.



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

def is_restart_at_each_section
  @is_restart_at_each_section
end

#link ⇒ Object

Gets or sets the link to the document.



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

def link
  @link
end

#list_id ⇒ Object

Gets or sets the unique identifier of the list. You do not normally need to use this property. But if you use it, you normally do so in conjunction with the Aspose.Words.Lists.ListCollection.GetListByListId(System.Int32) method to find a list by its identifier.



37
38
39
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 37

def list_id
  @list_id
end

#list_levels ⇒ Object

Gets or sets the collection of list levels for this list. Use this property to access and modify formatting individual to each level of the list.



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

def list_levels
  @list_levels
end

#style ⇒ Object

Gets or sets the list style that this list references or defines. If this list is not associated with a list style, the property will return null. A list could be a reference to a list style, in this case Aspose.Words.Lists.List.IsListStyleReference will be true. A list could be a definition of a list style, in this case Aspose.Words.Lists.List.IsListStyleDefinition will be true. Such a list cannot be applied to paragraphs in the document directly.



57
58
59
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 57

def style
  @style
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 63

def self.attribute_map
  {
    :'link' => :'Link',
    :'list_id' => :'ListId',
    :'is_multi_level' => :'IsMultiLevel',
    :'is_restart_at_each_section' => :'IsRestartAtEachSection',
    :'is_list_style_definition' => :'IsListStyleDefinition',
    :'is_list_style_reference' => :'IsListStyleReference',
    :'style' => :'Style',
    :'list_levels' => :'ListLevels'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 77

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'list_id' => :'Integer',
    :'is_multi_level' => :'BOOLEAN',
    :'is_restart_at_each_section' => :'BOOLEAN',
    :'is_list_style_definition' => :'BOOLEAN',
    :'is_list_style_reference' => :'BOOLEAN',
    :'style' => :'Style',
    :'list_levels' => :'ListLevels'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 139

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      link == other.link &&
      list_id == other.list_id &&
      is_multi_level == other.is_multi_level &&
      is_restart_at_each_section == other.is_restart_at_each_section &&
      is_list_style_definition == other.is_list_style_definition &&
      is_list_style_reference == other.is_list_style_reference &&
      style == other.style &&
      list_levels == other.list_levels
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



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

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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 260

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 167

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 



274
275
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 274

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


154
155
156
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 154

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



160
161
162
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 160

def hash
  [link, list_id, is_multi_level, is_restart_at_each_section, is_list_style_definition, is_list_style_reference, style, list_levels].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



240
241
242
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 240

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



246
247
248
249
250
251
252
253
254
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 246

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



234
235
236
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 234

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



133
134
135
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 133

def valid?
  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/aspose_words_cloud/models/list_info.rb', line 277

def validate()
  raise ArgumentError, 'Property list_id in ListInfo is required.' if self.list_id.nil?
  raise ArgumentError, 'Property is_multi_level in ListInfo is required.' if self.is_multi_level.nil?
  raise ArgumentError, 'Property is_restart_at_each_section in ListInfo is required.' if self.is_restart_at_each_section.nil?
  raise ArgumentError, 'Property is_list_style_definition in ListInfo is required.' if self.is_list_style_definition.nil?
  raise ArgumentError, 'Property is_list_style_reference in ListInfo is required.' if self.is_list_style_reference.nil?
  unless self.link.nil?
      self.link.validate
  end
  unless self.style.nil?
      self.style.validate
  end
  unless self.list_levels.nil?
      self.list_levels.validate
  end

end