Class: DynamicPDFApi::ButtonFieldInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby_client/ButtonFieldInformation.rb

Overview

Represents information of a button field.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ButtonFieldInformation

Returns a new instance of ButtonFieldInformation.



6
7
8
9
10
11
12
13
 
# File 'lib/ruby_client/ButtonFieldInformation.rb', line 6

def initialize
  @name = nil
  @_type = nil
  @value = nil
  @default_value = nil
  @export_value = nil
  @export_values = {}
end

Instance Attribute Details

#default_value ⇒ Object

Gets or Sets the default value of the button field.



33
34
35
 
# File 'lib/ruby_client/ButtonFieldInformation.rb', line 33

def default_value
  @default_value
end

#export_value ⇒ Object

Gets or Sets the export value. These values will be exported when submitting the form.

To create a set of mutually exclusive radio buttons (i.e., where only one can be selected at a time), create the fields with the same name but different export values.



41
42
43
 
# File 'lib/ruby_client/ButtonFieldInformation.rb', line 41

def export_value
  @export_value
end

#export_values ⇒ Object

Gets the collection of export value.



46
47
48
 
# File 'lib/ruby_client/ButtonFieldInformation.rb', line 46

def export_values
  @export_values
end

#name ⇒ Object

Gets or Sets the name of the button field.



18
19
20
 
# File 'lib/ruby_client/ButtonFieldInformation.rb', line 18

def name
  @name
end

#type ⇒ Object

Gets or sets the type of the button field, ex: RadioButton, CheckBox etc.



23
24
25
 
# File 'lib/ruby_client/ButtonFieldInformation.rb', line 23

def type
  @type
end

#value ⇒ Object

Gets or sets the value of the button field.



28
29
30
 
# File 'lib/ruby_client/ButtonFieldInformation.rb', line 28

def value
  @value
end