class AsposeWordsCloud::FootnoteInsert
Footnote
for insert.
Attributes
Gets or sets the option, that specifies whether this is a footnote or endnote.
Gets or sets the link to range start node.
Gets or sets the custom reference mark to be used for this footnote. Default value is Empty, meaning auto-numbered footnotes are used. RTF-format can only store 1 symbol as custom reference mark, so upon export only the first symbol will be written others will be discard.
Gets or sets text of the footnote. This method allows to quickly set text of a footnote from a string. The string can contain paragraph breaks, this will create paragraphs of text in the footnote accordingly.
Public Class Methods
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 70 def self.attribute_map { :'position' => :'Position', :'footnote_type' => :'FootnoteType', :'reference_mark' => :'ReferenceMark', :'text' => :'Text' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 91 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?(:'Position') self.position = attributes[:'Position'] end if attributes.key?(:'FootnoteType') self.footnote_type = attributes[:'FootnoteType'] end if attributes.key?(:'ReferenceMark') self.reference_mark = attributes[:'ReferenceMark'] end if attributes.key?(:'Text') self.text = attributes[:'Text'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 80 def self.swagger_types { :'position' => :'Position', :'footnote_type' => :'String', :'reference_mark' => :'String', :'text' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 140 def ==(other) return true if self.equal?(other) self.class == other.class && position == other.position && footnote_type == other.footnote_type && reference_mark == other.reference_mark && text == other.text end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 186 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 257 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
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
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 164 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 271 def collectFilesContent(resultFilesContent) end
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 151 def eql?(other) self == other end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 125 def footnote_type=(footnote_type) validator = EnumAttributeValidator.new('String', ["Footnote", "Endnote"]) if footnote_type.to_i == 0 unless validator.valid?(footnote_type) raise ArgumentError, "invalid value for 'footnote_type', must be one of #{validator.allowable_values}." end @footnote_type = footnote_type else @footnote_type = validator.allowable_values[footnote_type.to_i] end end
Custom attribute writer method checking allowed values (enum). @param [Object] footnote_type
Object to be assigned
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 157 def hash [position, footnote_type, reference_mark, text].hash end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
Source
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 243 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 object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 231 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 116 def valid? footnote_type_validator = EnumAttributeValidator.new('String', ["Footnote", "Endnote"]) return false unless footnote_type_validator.valid?(@footnote_type) return true end
Check to see if the all the properties in the model are valid @return true if the model is valid
Source
# File lib/aspose_words_cloud/models/footnote_insert.rb, line 274 def validate() unless self.position.nil? self.position.validate end end