com.spire.presentation
Class ClickHyperlink

java.lang.Object
  com.spire.presentation.ClickHyperlink

public class ClickHyperlink
extends java.lang.Object

Represents a hyperlink associated with a non-placeholder shape or text.

Constructor Summary

ClickHyperlink()

ClickHyperlink(boolean external, java.lang.String uri, java.lang.String action)

ClickHyperlink(ClickHyperlink source, java.lang.String targetFrame, java.lang.String tooltip, boolean history, boolean stopSoundsOnClick, boolean isHighlightClick)
Creates an instance of a hyperlink using another hyperlink as source, overriding secondary properties.

ClickHyperlink(ISlide slide)
Creates an instance of a hyperlink.

ClickHyperlink(PptxBaseXmlElement source)

ClickHyperlink(java.lang.String hyperlinkUrl)
Creates an instance of a hyperlink.

Method Summary

boolean	equals(ClickHyperlink hlink) Indicates whether the two Hyperlink instances are equal.
boolean	equals(java.lang.Object obj) Indicates whether the two Hyperlink instances are equal.
java.lang.String	getAction()
HyperlinkActionType	getActionType() Represents the type of hyperlink.
java.lang.String	getAddress() Returns the Internet address (URL) to the target document.
boolean	getEndSounds() Indicates whether the sound should be stopped on hyperlink click.
boolean	getHistory() Indicates whether the target will be added to a list.
java.lang.String	getInvalidUrl()
boolean	getStopSoundOnClick() Determines whether the sound should be stopped on hyperlink click.
java.lang.String	getTargetFrame() Gets the frame within the parent HTML frameset Read-only .
Slide	getTargetSlide() If the Hyperlink targets specific slide returns this slide.
java.lang.String	getTooltip() Returns or sets the ScreenTip text of a hyperlink.
int	hashCode() Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
boolean	isHighlightClick() Indicates whether the hyperlink should be highlighted on click.
static boolean	op_Equality(ClickHyperlink hlink1, ClickHyperlink hlink2) Tests two hyperlinks for equality.
static boolean	op_Inequality(ClickHyperlink hlink1, ClickHyperlink hlink2) Tests two hyperlinks for inequality.
void	setAddress(java.lang.String value) Sets the Internet address (URL) to the target document.

Constructor Detail

ClickHyperlink

public ClickHyperlink(java.lang.String hyperlinkUrl)

Creates an instance of a hyperlink.

Parameters:

hyperlinkUrl - Hyperlink URL.

ClickHyperlink

public ClickHyperlink()

ClickHyperlink

public ClickHyperlink(ISlide slide)

Creates an instance of a hyperlink.

Parameters:

slide -

Throws:

java.lang.Exception

ClickHyperlink

public ClickHyperlink(ClickHyperlink source,
                      java.lang.String targetFrame,
                      java.lang.String tooltip,
                      boolean history,
                      boolean stopSoundsOnClick,
                      boolean isHighlightClick)

Creates an instance of a hyperlink using another hyperlink as source, overriding secondary properties.

Parameters:

source - Source hyperlink

targetFrame - Target frame

tooltip - Tooltip text

history -

stopSoundsOnClick -

isHighlightClick -

ClickHyperlink

public ClickHyperlink(PptxBaseXmlElement source)

ClickHyperlink

public ClickHyperlink(boolean external,
                      java.lang.String uri,
                      java.lang.String action)

Method Detail

getAddress

public java.lang.String getAddress()

Returns the Internet address (URL) to the target document.

Returns:

setAddress

public void setAddress(java.lang.String value)

Sets the Internet address (URL) to the target document.

getInvalidUrl

public java.lang.String getInvalidUrl()

getAction

public java.lang.String getAction()

getActionType

public HyperlinkActionType getActionType()

Represents the type of hyperlink. Read-only. Readonly .

Returns:

getTargetSlide

public Slide getTargetSlide()

If the Hyperlink targets specific slide returns this slide. // Readonly .

Returns:

getTargetFrame

public java.lang.String getTargetFrame()

Gets the frame within the parent HTML frameset Read-only .

Returns:

getTooltip

public java.lang.String getTooltip()

Returns or sets the ScreenTip text of a hyperlink. Read-only .

Returns:

getHistory

public boolean getHistory()

Indicates whether the target will be added to a list. Read-only .

Returns:

isHighlightClick

public boolean isHighlightClick()

Indicates whether the hyperlink should be highlighted on click. Read-only .

Returns:

getStopSoundOnClick

public boolean getStopSoundOnClick()

Determines whether the sound should be stopped on hyperlink click. Read-only .

Returns:

getEndSounds

public boolean getEndSounds()

Indicates whether the sound should be stopped on hyperlink click. Read-only .

Returns:

equals

public boolean equals(java.lang.Object obj)

Indicates whether the two Hyperlink instances are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The Hyperlink to compare with the current Hyperlink.

Returns:

equals

public boolean equals(ClickHyperlink hlink)

Indicates whether the two Hyperlink instances are equal.

Parameters:

hlink - The Hyperlink to compare with the current Hyperlink.

Returns:

op_Equality

public static boolean op_Equality(ClickHyperlink hlink1,
                                  ClickHyperlink hlink2)

Tests two hyperlinks for equality.

Parameters:

hlink1 - First hyperlink to be tested.

hlink2 - Second hyperlink to be tested.

Returns:

True if hyperlinks are equal.

op_Inequality

public static boolean op_Inequality(ClickHyperlink hlink1,
                                    ClickHyperlink hlink2)

Tests two hyperlinks for inequality.

Parameters:

hlink1 - First hyperlink to be tested.

hlink2 - Second hyperlink to be tested.

Returns:

False if hyperlinks are equal.

hashCode

public int hashCode()

Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class java.lang.Object

Returns:

Hash code for an URL.