class AsposePdfCloud::FileAttachmentAnnotation
Provides FileAttachmentAnnotation
.
Attributes
Color
of the annotation.
Get the annotation content.
The date and time when the annotation was created.
Gets or sets text associated with the file specification.
Gets or sets file specification name.
Sets content file path.
Gets Flags of the annotation.
Gets HorizontalAlignment
of the annotation.
Gets or sets icon that shall be used in displaying annotation.
Gets ID of the annotation.
Link
to the document.
The date and time when the annotation was last modified.
Gets Name of the annotation.
Gets or sets icon’s opacity from 0 to 1: 0 - completely transparant, 1 - completely opaque.
Gets PageIndex of the annotation.
Gets Rect of the annotation.
Get the annotation RichText.
Get the annotation subject.
Get the annotation title.
Gets VerticalAlignment
of the annotation.
Gets ZIndex of the annotation.
Public Class Methods
Source
# File lib/aspose_pdf_cloud/models/file_attachment_annotation.rb, line 93 def self.attribute_map { :'links' => :'Links', :'color' => :'Color', :'contents' => :'Contents', :'modified' => :'Modified', :'id' => :'Id', :'flags' => :'Flags', :'name' => :'Name', :'rect' => :'Rect', :'page_index' => :'PageIndex', :'z_index' => :'ZIndex', :'horizontal_alignment' => :'HorizontalAlignment', :'vertical_alignment' => :'VerticalAlignment', :'creation_date' => :'CreationDate', :'subject' => :'Subject', :'title' => :'Title', :'rich_text' => :'RichText', :'icon' => :'Icon', :'opacity' => :'Opacity', :'file_description' => :'FileDescription', :'file_name' => :'FileName', :'file_path' => :'FilePath' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/aspose_pdf_cloud/models/file_attachment_annotation.rb, line 148 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?(:'Color') self.color = attributes[:'Color'] end if attributes.has_key?(:'Contents') self.contents = attributes[:'Contents'] end if attributes.has_key?(:'Modified') self.modified = attributes[:'Modified'] end if attributes.has_key?(:'Id') self.id = attributes[:'Id'] end if attributes.has_key?(:'Flags') if (value = attributes[:'Flags']).is_a?(Array) self.flags = value end end if attributes.has_key?(:'Name') self.name = attributes[:'Name'] end if attributes.has_key?(:'Rect') self.rect = attributes[:'Rect'] end if attributes.has_key?(:'PageIndex') self.page_index = attributes[:'PageIndex'] end if attributes.has_key?(:'ZIndex') self.z_index = attributes[:'ZIndex'] 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?(:'CreationDate') self.creation_date = attributes[:'CreationDate'] end if attributes.has_key?(:'Subject') self.subject = attributes[:'Subject'] end if attributes.has_key?(:'Title') self.title = attributes[:'Title'] end if attributes.has_key?(:'RichText') self.rich_text = attributes[:'RichText'] end if attributes.has_key?(:'Icon') self.icon = attributes[:'Icon'] end if attributes.has_key?(:'Opacity') self.opacity = attributes[:'Opacity'] end if attributes.has_key?(:'FileDescription') self.file_description = attributes[:'FileDescription'] end if attributes.has_key?(:'FileName') self.file_name = attributes[:'FileName'] end if attributes.has_key?(:'FilePath') self.file_path = attributes[:'FilePath'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/aspose_pdf_cloud/models/file_attachment_annotation.rb, line 120 def self.swagger_types { :'links' => :'Array<Link>', :'color' => :'Color', :'contents' => :'String', :'modified' => :'String', :'id' => :'String', :'flags' => :'Array<AnnotationFlags>', :'name' => :'String', :'rect' => :'Rectangle', :'page_index' => :'Integer', :'z_index' => :'Integer', :'horizontal_alignment' => :'HorizontalAlignment', :'vertical_alignment' => :'VerticalAlignment', :'creation_date' => :'String', :'subject' => :'String', :'title' => :'String', :'rich_text' => :'String', :'icon' => :'FileIcon', :'opacity' => :'Float', :'file_description' => :'String', :'file_name' => :'String', :'file_path' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/aspose_pdf_cloud/models/file_attachment_annotation.rb, line 264 def ==(o) return true if self.equal?(o) self.class == o.class && links == o.links && color == o.color && contents == o.contents && modified == o.modified && id == o.id && flags == o.flags && name == o.name && rect == o.rect && page_index == o.page_index && z_index == o.z_index && horizontal_alignment == o.horizontal_alignment && vertical_alignment == o.vertical_alignment && creation_date == o.creation_date && subject == o.subject && title == o.title && rich_text == o.rich_text && icon == o.icon && opacity == o.opacity && file_description == o.file_description && file_name == o.file_name && file_path == o.file_path end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/aspose_pdf_cloud/models/file_attachment_annotation.rb, line 326 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
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_pdf_cloud/models/file_attachment_annotation.rb, line 392 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_pdf_cloud/models/file_attachment_annotation.rb, line 305 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_pdf_cloud/models/file_attachment_annotation.rb, line 292 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/aspose_pdf_cloud/models/file_attachment_annotation.rb, line 298 def hash [links, color, contents, modified, id, flags, name, rect, page_index, z_index, horizontal_alignment, vertical_alignment, creation_date, subject, title, rich_text, icon, opacity, file_description, file_name, file_path].hash end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
Source
# File lib/aspose_pdf_cloud/models/file_attachment_annotation.rb, line 246 def list_invalid_properties invalid_properties = Array.new if @rect.nil? invalid_properties.push("invalid value for 'rect', rect cannot be nil.") end return invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
Source
Source
# File lib/aspose_pdf_cloud/models/file_attachment_annotation.rb, line 378 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_pdf_cloud/models/file_attachment_annotation.rb, line 366 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_pdf_cloud/models/file_attachment_annotation.rb, line 257 def valid? return false if @rect.nil? return true end
Check to see if the all the properties in the model are valid @return true if the model is valid