Class: AsposeWordsCloud::FormFieldTextInput

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

Overview

FormField text input element.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormFieldTextInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'MaxLength')
    self.max_length = attributes[:'MaxLength']
  end

  if attributes.key?(:'TextInputDefault')
    self.text_input_default = attributes[:'TextInputDefault']
  end

  if attributes.key?(:'TextInputFormat')
    self.text_input_format = attributes[:'TextInputFormat']
  end

  if attributes.key?(:'TextInputType')
    self.text_input_type = attributes[:'TextInputType']
  end

end

Instance Attribute Details

#calculate_on_exit ⇒ Object

Gets or sets true if references to the specified form field are automatically updated whenever the field is exited.



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

def calculate_on_exit
  @calculate_on_exit
end

#enabled ⇒ Object

Gets or sets true if a form field is enabled.



44
45
46
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 44

def enabled
  @enabled
end

#entry_macro ⇒ Object

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



47
48
49
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 47

def entry_macro
  @entry_macro
end

#exit_macro ⇒ Object

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



50
51
52
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 50

def exit_macro
  @exit_macro
end

#help_text ⇒ Object

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



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

def help_text
  @help_text
end

#link ⇒ Object

Gets or sets link to the document.



35
36
37
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 35

def link
  @link
end

#max_length ⇒ Object

Gets or sets maximum length for the text field. Zero when the length is not limited.



68
69
70
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 68

def max_length
  @max_length
end

#name ⇒ Object

Gets or sets the form field name.



56
57
58
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 56

def name
  @name
end

#node_id ⇒ Object

Gets or sets node id.



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

def node_id
  @node_id
end

#own_help ⇒ Object

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



59
60
61
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 59

def own_help
  @own_help
end

#own_status ⇒ Object

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



62
63
64
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 62

def own_status
  @own_status
end

#status_text ⇒ Object

Gets or sets returns or sets the text that’s displayed in the status bar when a form field has the focus.



65
66
67
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 65

def status_text
  @status_text
end

#text_input_default ⇒ Object

Gets or sets the default string or a calculation expression of a text form field.



71
72
73
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 71

def text_input_default
  @text_input_default
end

#text_input_format ⇒ Object

Gets or sets returns or sets the text formatting for a text form field.



74
75
76
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 74

def text_input_format
  @text_input_format
end

#text_input_type ⇒ Object

Gets or sets the type of a text form field.



77
78
79
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 77

def text_input_type
  @text_input_type
end

Class Method Details

.attribute_map ⇒ Object

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 102

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',
    :'max_length' => :'MaxLength',
    :'text_input_default' => :'TextInputDefault',
    :'text_input_format' => :'TextInputFormat',
    :'text_input_type' => :'TextInputType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    :'max_length' => :'Integer',
    :'text_input_default' => :'String',
    :'text_input_format' => :'String',
    :'text_input_type' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 244

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 &&
      max_length == other.max_length &&
      text_input_default == other.text_input_default &&
      text_input_format == other.text_input_format &&
      text_input_type == other.text_input_type
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



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

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 368

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



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

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

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



272
273
274
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 272

def hash
  [link, node_id, calculate_on_exit, enabled, entry_macro, exit_macro, help_text, name, own_help, own_status, status_text, max_length, text_input_default, text_input_format, text_input_type].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



215
216
217
218
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 215

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



348
349
350
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 348

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



354
355
356
357
358
359
360
361
362
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 354

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



342
343
344
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 342

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



222
223
224
225
226
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 222

def valid?
  text_input_type_validator = EnumAttributeValidator.new('String', ["Regular", "Number", "Date", "CurrentDate", "CurrentTime", "Calculated"])
  return false unless text_input_type_validator.valid?(@text_input_type)
  return true
end