Class: DynamicPDFApi::ChoiceFieldInformation

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

Overview

Represents the information of a choice field in interactive forms. A choice field contains several text items, one or more of which may be selected as the field value.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ChoiceFieldInformation

Returns a new instance of ChoiceFieldInformation.



7
8
9
10
11
12
13
14
15
 
# File 'lib/ruby_client/ChoiceFieldInformation.rb', line 7

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

Instance Attribute Details

#default_value ⇒ Object

Gets or Sets the default value of the choice field.



35
36
37
 
# File 'lib/ruby_client/ChoiceFieldInformation.rb', line 35

def default_value
  @default_value
end

#export_value ⇒ Object

Gets or Sets the export value.



40
41
42
 
# File 'lib/ruby_client/ChoiceFieldInformation.rb', line 40

def export_value
  @export_value
end

#item_export_values ⇒ Object

Gets the collection of export values of the items present in the choice field.



50
51
52
 
# File 'lib/ruby_client/ChoiceFieldInformation.rb', line 50

def item_export_values
  @item_export_values
end

#items ⇒ Object

Gets the collection of items.



45
46
47
 
# File 'lib/ruby_client/ChoiceFieldInformation.rb', line 45

def items
  @items
end

#name ⇒ Object

Gets or Sets the name of the choice field.



20
21
22
 
# File 'lib/ruby_client/ChoiceFieldInformation.rb', line 20

def name
  @name
end

#type ⇒ Object

Gets or sets the ChoiceFieldType. ex: ListBox, ComboBox etc.



25
26
27
 
# File 'lib/ruby_client/ChoiceFieldInformation.rb', line 25

def type
  @type
end

#value ⇒ Object

Gets or sets the value of the choice field.



30
31
32
 
# File 'lib/ruby_client/ChoiceFieldInformation.rb', line 30

def value
  @value
end