Class: AsposeSlidesCloud::Hyperlink

Inherits:
BaseObject show all
Defined in:
lib/aspose_slides_cloud/models/hyperlink.rb

Overview

Hyperlink

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseObject

#_deserialize, #_to_hash, #build_from_hash, #to_body, #to_hash, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Hyperlink

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# 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

Instance Attribute Details

#action_type ⇒ Object

Type of HyperLink action



32
33
34
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 32

def action_type
  @action_type
end

#color_source ⇒ Object

Represents the source of hyperlink color



56
57
58
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 56

def color_source
  @color_source
end

#external_url ⇒ Object

Specifies the external URL



35
36
37
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 35

def external_url
  @external_url
end

#highlight_click ⇒ Object

Determines whether the hyperlink should be highlighted on click.



50
51
52
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 50

def highlight_click
  @highlight_click
end

#history ⇒ Object

Makes hyperlink viewed when it is invoked.



47
48
49
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 47

def history
  @history
end

#is_disabled ⇒ Object

If true Hypelink is not applied.



29
30
31
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 29

def is_disabled
  @is_disabled
end

#sound_base64 ⇒ Object

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



59
60
61
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 59

def sound_base64
  @sound_base64
end

#stop_sound_on_click ⇒ Object

Determines whether the sound should be stopped on hyperlink click



53
54
55
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 53

def stop_sound_on_click
  @stop_sound_on_click
end

#target_frame ⇒ Object

Target frame



41
42
43
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 41

def target_frame
  @target_frame
end

#target_slide_index ⇒ Object

Index of the target slide



38
39
40
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 38

def target_slide_index
  @target_slide_index
end

#tooltip ⇒ Object

Hyperlink tooltip



44
45
46
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 44

def tooltip
  @tooltip
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


210
211
212
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



150
151
152
153
154
155
156
157
 
# 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? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



161
162
163
164
165
166
167
168
 
# 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