Class: AsposeWordsCloud::FormField

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

Overview

FromField.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormField

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 100

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

  if attributes.key?(:'CalculateOnExit')
    self.calculate_on_exit = attributes[:'CalculateOnExit']
  end

  if attributes.key?(:'Enabled')
    self.enabled = attributes[:'Enabled']
  end

  if attributes.key?(:'EntryMacro')
    self.entry_macro = attributes[:'EntryMacro']
  end

  if attributes.key?(:'ExitMacro')
    self.exit_macro = attributes[:'ExitMacro']
  end

  if attributes.key?(:'HelpText')
    self.help_text = attributes[:'HelpText']
  end

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

  if attributes.key?(:'OwnHelp')
    self.own_help = attributes[:'OwnHelp']
  end

  if attributes.key?(:'OwnStatus')
    self.own_status = attributes[:'OwnStatus']
  end

  if attributes.key?(:'StatusText')
    self.status_text = attributes[:'StatusText']
  end
end

Instance Attribute Details

#calculate_on_exit ⇒ Object

Gets or sets a value indicating whether references to the specified form field are automatically updated whenever the field is exited.



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

def calculate_on_exit
  @calculate_on_exit
end

#enabled ⇒ Object

Gets or sets a value indicating whether a form field is enabled.



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

def enabled
  @enabled
end

#entry_macro ⇒ Object

Gets or sets the entry macro name for the form field.



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

def entry_macro
  @entry_macro
end

#exit_macro ⇒ Object

Gets or sets the exit macro name for the form field.



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

def exit_macro
  @exit_macro
end

#help_text ⇒ Object

Gets or sets text, displayed in a message box when the form field has the focus and the user presses F1.



51
52
53
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 51

def help_text
  @help_text
end

#link ⇒ Object

Gets or sets the link to the document.



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

def link
  @link
end

#name ⇒ Object

Gets or sets the form field name.



54
55
56
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 54

def name
  @name
end

#node_id ⇒ Object

Gets or sets the node id.



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

def node_id
  @node_id
end

#own_help ⇒ Object

Gets or sets a value indicating whether the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.



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

def own_help
  @own_help
end

#own_status ⇒ Object

Gets or sets a value indicating whether the source of the text that’s displayed in the status bar when a form field has the focus.



60
61
62
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 60

def own_status
  @own_status
end

#status_text ⇒ Object

Gets or sets text, displayed in the status bar when a form field has the focus.



63
64
65
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 63

def status_text
  @status_text
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 65

def self.attribute_map
  {
    :'link' => :'Link',
    :'node_id' => :'NodeId',
    :'calculate_on_exit' => :'CalculateOnExit',
    :'enabled' => :'Enabled',
    :'entry_macro' => :'EntryMacro',
    :'exit_macro' => :'ExitMacro',
    :'help_text' => :'HelpText',
    :'name' => :'Name',
    :'own_help' => :'OwnHelp',
    :'own_status' => :'OwnStatus',
    :'status_text' => :'StatusText'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 82

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'node_id' => :'String',
    :'calculate_on_exit' => :'BOOLEAN',
    :'enabled' => :'BOOLEAN',
    :'entry_macro' => :'String',
    :'exit_macro' => :'String',
    :'help_text' => :'String',
    :'name' => :'String',
    :'own_help' => :'BOOLEAN',
    :'own_status' => :'BOOLEAN',
    :'status_text' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      link == other.link &&
      node_id == other.node_id &&
      calculate_on_exit == other.calculate_on_exit &&
      enabled == other.enabled &&
      entry_macro == other.entry_macro &&
      exit_macro == other.exit_macro &&
      help_text == other.help_text &&
      name == other.name &&
      own_help == other.own_help &&
      own_status == other.own_status &&
      status_text == other.status_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



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
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 219

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
    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



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 286

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 197

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 



300
301
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 300

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


184
185
186
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 184

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [link, node_id, calculate_on_exit, enabled, entry_macro, exit_macro, help_text, name, own_help, own_status, status_text].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



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

def list_invalid_properties
  invalid_properties = []
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



266
267
268
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 266

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



272
273
274
275
276
277
278
279
280
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 272

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



260
261
262
 
# File 'lib/aspose_words_cloud/models/form_field.rb', line 260

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



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

def valid?
  return true
end