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



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
212
213
214
215
216
217
218
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 153

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'MaxLength')
    self.max_length = attributes[:'MaxLength']
  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. Setting CalculateOnExit only affects the behavior of the form field when the document is opened in Microsoft Word. Aspose.Words never updates references to the form field.



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

def calculate_on_exit
  @calculate_on_exit
end

#enabled ⇒ Object

Gets or sets a value indicating whether a form field is enabled. If a form field is enabled, its contents can be changed as the form is filled in.



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

def enabled
  @enabled
end

#entry_macro ⇒ Object

Gets or sets the entry macro name for the form field. The entry macro runs when the form field gets the focus in Microsoft Word.



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

def entry_macro
  @entry_macro
end

#exit_macro ⇒ Object

Gets or sets the exit macro name for the form field. The exit macro runs when the form field loses the focus in Microsoft Word.



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

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. If the OwnHelp property is set to True, HelpText specifies the text string value. If OwnHelp is set to False, HelpText specifies the name of an AutoText entry that contains help text for the form field.



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

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_text_input.rb', line 33

def link
  @link
end

#max_length ⇒ Object

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



85
86
87
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 85

def max_length
  @max_length
end

#name ⇒ Object

Gets or sets the form field name.



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

def name
  @name
end

#node_id ⇒ Object

Gets or sets the node id.



36
37
38
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.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. If True, the text specified by the HelpText property is displayed. If False, the text in the AutoText entry specified by the HelpText property is displayed.



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 a value indicating whether the source of the text that’s displayed in the status bar when a form field has the focus. If true, the text specified by the StatusText property is displayed. If false, the text of the AutoText entry specified by the StatusText property is displayed.



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

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. If the OwnStatus property is set to true, the StatusText property specifies the status bar text. If the OwnStatus property is set to false, the StatusText property specifies the name of an AutoText entry that contains status bar text for the form field.



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

def status_text
  @status_text
end

#text_input_default ⇒ Object

Gets or sets the default string or a calculation expression of the text form field. The meaning of this property depends on the value of the TextInputType property.When TextInputType is Regular or Number, this string specifies the default string for the text form field. This string is the content that Microsoft Word will display in the document when the form field is empty.When TextInputType is Calculated, then this string holds the expression to be calculated. The expression needs to be a formula valid according to Microsoft Word formula field requirements. When you set a new expression using this property, Aspose.Words calculates the formula result automatically and inserts it into the form field.



82
83
84
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 82

def text_input_default
  @text_input_default
end

#text_input_format ⇒ Object

Gets or sets text formatting for the text form field. If the text form field contains regular text, then valid format strings are “”, “UPPERCASE”, “LOWERCASE”, “FIRST CAPITAL” and “TITLE CASE”. The strings are case-insensitive.If the text form field contains a number or a date/time value, then valid format strings are number or date and time format strings.



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

def text_input_format
  @text_input_format
end

#text_input_type ⇒ Object

Gets or sets the type of the text form field.



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

def text_input_type
  @text_input_type
end

Class Method Details

.attribute_map ⇒ Object

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



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/form_field_text_input.rb', line 110

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

.swagger_types ⇒ Object

Attribute type mapping.



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_text_input.rb', line 131

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



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
339
340
341
342
343
344
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 303

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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 374

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



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

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 



388
389
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 388

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


268
269
270
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 268

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

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



354
355
356
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 354

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



360
361
362
363
364
365
366
367
368
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 360

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



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

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

#validate ⇒ Object

Raises:

  • (ArgumentError) 


391
392
393
394
395
396
397
398
399
 
# File 'lib/aspose_words_cloud/models/form_field_text_input.rb', line 391

def validate()
  raise ArgumentError, 'Property name in FormFieldTextInput is required.' if self.name.nil?
  raise ArgumentError, 'Property text_input_format in FormFieldTextInput is required.' if self.text_input_format.nil?
  raise ArgumentError, 'Property text_input_default in FormFieldTextInput is required.' if self.text_input_default.nil?
  unless self.link.nil?
      self.link.validate
  end

end