class AsposeSlidesCloud::Hyperlink

Hyperlink

Attributes

action_type[RW]

Type of HyperLink action

color_source[RW]

Represents the source of hyperlink color

external_url[RW]

Specifies the external URL

highlight_click[RW]

Determines whether the hyperlink should be highlighted on click.

history[RW]

Makes hyperlink viewed when it is invoked.

is_disabled[RW]

If true Hypelink is not applied.

sound_base64[RW]

Audio data encoded in base64. Represents the playing sound of the hyperlink.

stop_sound_on_click[RW]

Determines whether the sound should be stopped on hyperlink click

target_frame[RW]

Target frame

target_slide_index[RW]

Index of the target slide

tooltip[RW]

Hyperlink tooltip

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/aspose_slides_cloud/models/hyperlink.rb, line 62
def self.attribute_map
  {
    :'is_disabled' => :'IsDisabled',
    :'action_type' => :'ActionType',
    :'external_url' => :'ExternalUrl',
    :'target_slide_index' => :'TargetSlideIndex',
    :'target_frame' => :'TargetFrame',
    :'tooltip' => :'Tooltip',
    :'history' => :'History',
    :'highlight_click' => :'HighlightClick',
    :'stop_sound_on_click' => :'StopSoundOnClick',
    :'color_source' => :'ColorSource',
    :'sound_base64' => :'SoundBase64',
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/aspose_slides_cloud/models/hyperlink.rb, line 97
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?(:'IsDisabled')
    self.is_disabled = attributes[:'IsDisabled']
  end

  if attributes.has_key?(:'ActionType')
    self.action_type = attributes[:'ActionType']
  end

  if attributes.has_key?(:'ExternalUrl')
    self.external_url = attributes[:'ExternalUrl']
  end

  if attributes.has_key?(:'TargetSlideIndex')
    self.target_slide_index = attributes[:'TargetSlideIndex']
  end

  if attributes.has_key?(:'TargetFrame')
    self.target_frame = attributes[:'TargetFrame']
  end

  if attributes.has_key?(:'Tooltip')
    self.tooltip = attributes[:'Tooltip']
  end

  if attributes.has_key?(:'History')
    self.history = attributes[:'History']
  end

  if attributes.has_key?(:'HighlightClick')
    self.highlight_click = attributes[:'HighlightClick']
  end

  if attributes.has_key?(:'StopSoundOnClick')
    self.stop_sound_on_click = attributes[:'StopSoundOnClick']
  end

  if attributes.has_key?(:'ColorSource')
    self.color_source = attributes[:'ColorSource']
  end

  if attributes.has_key?(:'SoundBase64')
    self.sound_base64 = attributes[:'SoundBase64']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_slides_cloud/models/hyperlink.rb, line 79
def self.swagger_types
  {
    :'is_disabled' => :'BOOLEAN',
    :'action_type' => :'String',
    :'external_url' => :'String',
    :'target_slide_index' => :'Integer',
    :'target_frame' => :'String',
    :'tooltip' => :'String',
    :'history' => :'BOOLEAN',
    :'highlight_click' => :'BOOLEAN',
    :'stop_sound_on_click' => :'BOOLEAN',
    :'color_source' => :'String',
    :'sound_base64' => :'String',
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/hyperlink.rb, line 192
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      is_disabled == o.is_disabled &&
      action_type == o.action_type &&
      external_url == o.external_url &&
      target_slide_index == o.target_slide_index &&
      target_frame == o.target_frame &&
      tooltip == o.tooltip &&
      history == o.history &&
      highlight_click == o.highlight_click &&
      stop_sound_on_click == o.stop_sound_on_click &&
      color_source == o.color_source &&
      sound_base64 == o.sound_base64
end
action_type=(action_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] action_type Object to be assigned

# File lib/aspose_slides_cloud/models/hyperlink.rb, line 172
def action_type=(action_type)
  validator = EnumAttributeValidator.new('String', ['NoAction', 'Hyperlink', 'JumpFirstSlide', 'JumpPreviousSlide', 'JumpNextSlide', 'JumpLastSlide', 'JumpEndShow', 'JumpLastViewedSlide', 'JumpSpecificSlide', 'StartCustomSlideShow', 'OpenFile', 'OpenPresentation', 'StartStopMedia', 'StartMacro', 'StartProgram', 'Unknown'])
  unless validator.valid?(action_type)
    fail ArgumentError, 'invalid value for "action_type", must be one of #{validator.allowable_values}.'
  end
  @action_type = action_type
end
color_source=(color_source) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] color_source Object to be assigned

# File lib/aspose_slides_cloud/models/hyperlink.rb, line 182
def color_source=(color_source)
  validator = EnumAttributeValidator.new('String', ['Styles', 'PortionFormat'])
  unless validator.valid?(color_source)
    fail ArgumentError, 'invalid value for "color_source", must be one of #{validator.allowable_values}.'
  end
  @color_source = color_source
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/hyperlink.rb, line 210
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose_slides_cloud/models/hyperlink.rb, line 216
def hash
  [is_disabled, action_type, external_url, target_slide_index, target_frame, tooltip, history, highlight_click, stop_sound_on_click, color_source, sound_base64].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/aspose_slides_cloud/models/hyperlink.rb, line 150
def list_invalid_properties
  invalid_properties = Array.new
  if @action_type.nil?
    invalid_properties.push('invalid value for "action_type", action_type cannot be nil.')
  end

  invalid_properties
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose_slides_cloud/models/hyperlink.rb, line 161
def valid?
  return false if @action_type.nil?
  action_type_validator = EnumAttributeValidator.new('String', ['NoAction', 'Hyperlink', 'JumpFirstSlide', 'JumpPreviousSlide', 'JumpNextSlide', 'JumpLastSlide', 'JumpEndShow', 'JumpLastViewedSlide', 'JumpSpecificSlide', 'StartCustomSlideShow', 'OpenFile', 'OpenPresentation', 'StartStopMedia', 'StartMacro', 'StartProgram', 'Unknown'])
  return false unless action_type_validator.valid?(@action_type)
  color_source_validator = EnumAttributeValidator.new('String', ['Styles', 'PortionFormat'])
  return false unless color_source_validator.valid?(@color_source)
  true
end