class AsposePdfCloud::ComboBoxField
Provides ComboBoxField
.
Attributes
Gets or sets current annotation appearance state.
Gets or sets annotation border characteristics.
Color
of the annotation.
Get the field content.
Gets or sets editable status of the field.
Gets Flags of the field.
Full Field
name.
Gets or sets height of the field.
Field
highlighting mode.
Gets HorizontalAlignment
of the field.
Is group.
Link
to the document.
Gets or sets a outer margin for paragraph (for pdf generation)
Gets or sets multiselection flag.
Gets collection of options of the combobox.
Page
index.
Gets field parent.
Field
name.
Field
rectangle.
Gets or sets index of selected item. Numbering of items is started from 1.
Gets or sets spellchaeck activiity status.
Field
value.
Gets VerticalAlignment
of the field.
Gets or sets width of the field.
Z index.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 108 def self.attribute_map { :'links' => :'Links', :'partial_name' => :'PartialName', :'full_name' => :'FullName', :'rect' => :'Rect', :'value' => :'Value', :'page_index' => :'PageIndex', :'height' => :'Height', :'width' => :'Width', :'z_index' => :'ZIndex', :'is_group' => :'IsGroup', :'parent' => :'Parent', :'is_shared_field' => :'IsSharedField', :'flags' => :'Flags', :'color' => :'Color', :'contents' => :'Contents', :'margin' => :'Margin', :'highlighting' => :'Highlighting', :'horizontal_alignment' => :'HorizontalAlignment', :'vertical_alignment' => :'VerticalAlignment', :'border' => :'Border', :'multi_select' => :'MultiSelect', :'selected' => :'Selected', :'options' => :'Options', :'active_state' => :'ActiveState', :'editable' => :'Editable', :'spell_check' => :'SpellCheck' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 173 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.has_key?(:'Links') if (value = attributes[:'Links']).is_a?(Array) self.links = value end end if attributes.has_key?(:'PartialName') self.partial_name = attributes[:'PartialName'] end if attributes.has_key?(:'FullName') self.full_name = attributes[:'FullName'] end if attributes.has_key?(:'Rect') self.rect = attributes[:'Rect'] end if attributes.has_key?(:'Value') self.value = attributes[:'Value'] end if attributes.has_key?(:'PageIndex') self.page_index = attributes[:'PageIndex'] end if attributes.has_key?(:'Height') self.height = attributes[:'Height'] end if attributes.has_key?(:'Width') self.width = attributes[:'Width'] end if attributes.has_key?(:'ZIndex') self.z_index = attributes[:'ZIndex'] end if attributes.has_key?(:'IsGroup') self.is_group = attributes[:'IsGroup'] end if attributes.has_key?(:'Parent') self.parent = attributes[:'Parent'] end if attributes.has_key?(:'IsSharedField') self.is_shared_field = attributes[:'IsSharedField'] end if attributes.has_key?(:'Flags') if (value = attributes[:'Flags']).is_a?(Array) self.flags = value end end if attributes.has_key?(:'Color') self.color = attributes[:'Color'] end if attributes.has_key?(:'Contents') self.contents = attributes[:'Contents'] end if attributes.has_key?(:'Margin') self.margin = attributes[:'Margin'] end if attributes.has_key?(:'Highlighting') self.highlighting = attributes[:'Highlighting'] end if attributes.has_key?(:'HorizontalAlignment') self.horizontal_alignment = attributes[:'HorizontalAlignment'] end if attributes.has_key?(:'VerticalAlignment') self.vertical_alignment = attributes[:'VerticalAlignment'] end if attributes.has_key?(:'Border') self.border = attributes[:'Border'] end if attributes.has_key?(:'MultiSelect') self.multi_select = attributes[:'MultiSelect'] end if attributes.has_key?(:'Selected') self.selected = attributes[:'Selected'] end if attributes.has_key?(:'Options') if (value = attributes[:'Options']).is_a?(Array) self.options = value end end if attributes.has_key?(:'ActiveState') self.active_state = attributes[:'ActiveState'] end if attributes.has_key?(:'Editable') self.editable = attributes[:'Editable'] end if attributes.has_key?(:'SpellCheck') self.spell_check = attributes[:'SpellCheck'] end end
Attribute type mapping.
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 140 def self.swagger_types { :'links' => :'Array<Link>', :'partial_name' => :'String', :'full_name' => :'String', :'rect' => :'Rectangle', :'value' => :'String', :'page_index' => :'Integer', :'height' => :'Float', :'width' => :'Float', :'z_index' => :'Integer', :'is_group' => :'BOOLEAN', :'parent' => :'FormField', :'is_shared_field' => :'BOOLEAN', :'flags' => :'Array<AnnotationFlags>', :'color' => :'Color', :'contents' => :'String', :'margin' => :'MarginInfo', :'highlighting' => :'LinkHighlightingMode', :'horizontal_alignment' => :'HorizontalAlignment', :'vertical_alignment' => :'VerticalAlignment', :'border' => :'Border', :'multi_select' => :'BOOLEAN', :'selected' => :'Integer', :'options' => :'Array<Option>', :'active_state' => :'String', :'editable' => :'BOOLEAN', :'spell_check' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 311 def ==(o) return true if self.equal?(o) self.class == o.class && links == o.links && partial_name == o.partial_name && full_name == o.full_name && rect == o.rect && value == o.value && page_index == o.page_index && height == o.height && width == o.width && z_index == o.z_index && is_group == o.is_group && parent == o.parent && is_shared_field == o.is_shared_field && flags == o.flags && color == o.color && contents == o.contents && margin == o.margin && highlighting == o.highlighting && horizontal_alignment == o.horizontal_alignment && vertical_alignment == o.vertical_alignment && border == o.border && multi_select == o.multi_select && selected == o.selected && options == o.options && active_state == o.active_state && editable == o.editable && spell_check == o.spell_check end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 378 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) 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 = AsposePdfCloud.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 444 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 357 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 344 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 350 def hash [links, partial_name, full_name, rect, value, page_index, height, width, z_index, is_group, parent, is_shared_field, flags, color, contents, margin, highlighting, horizontal_alignment, vertical_alignment, border, multi_select, selected, options, active_state, editable, spell_check].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 293 def list_invalid_properties invalid_properties = Array.new if @page_index.nil? invalid_properties.push("invalid value for 'page_index', page_index cannot be nil.") end return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 430 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 418 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/aspose_pdf_cloud/models/combo_box_field.rb, line 304 def valid? return false if @page_index.nil? return true end