Hyperlink

Represents a hyperlink.

NameDescription
Hyperlink(String)Creates an instance of a hyperlink.

Parameters:

NameTypeDescription
urlStringHyperlink URL.

Returns: Hyperlink


NameDescription
Hyperlink(Slide)Creates an instance of a hyperlink which points to specific slide. Note: created hyperlink should be assigned to some object from the same presentation, otherwise link will be saved as NoAction.

Parameters:

NameTypeDescription
slideSlideTarget slide.

Returns: Hyperlink


NameDescription
Hyperlink(Hyperlink, String, String, boolean, boolean, boolean)Creates an instance of a hyperlink using another hyperlink as source, overriding secondary properties.

Parameters:

NameTypeDescription
sourceHyperlinkSource hyperlink
targetFrameStringTarget frame
tooltipStringTooltip text
historybooleanDetermines whether the target of the parent hyperlink shall be added to a list of viewed hyperlinks when it is invoked.
stopSoundsOnClickbooleanDetermines whether the sound should be stopped on hyperlink click.
highlightClickbooleanDetermines whether the hyperlink should be highlighted on click.

Returns: Hyperlink


equals

NameDescription
equals (Object)Determines whether the two Hyperlink instances are equal.

Parameters:

NameTypeDescription
objObjectThe Hyperlink to compare with the current Hyperlink.

Returns: boolean


equals

NameDescription
equals (Hyperlink)Determines whether the two Hyperlink instances are equal.

Parameters:

NameTypeDescription
hlinkHyperlinkThe Hyperlink to compare with the current Hyperlink.

Returns: boolean


getActionType

NameDescription
getActionType ()Returns type of Hyperlink’s action. Read-only HyperlinkActionType.

Returns: int


getColorSource

NameDescription
getColorSource ()Represents the source of hyperlink color - either styles or portion format. Read/write HyperlinkColorSource.

Returns: int


getEndShow

NameDescription
getEndShow ()Returns a hyperlink which ends the show. Read-only Hyperlink.

Returns: Hyperlink


getExternalUrl

NameDescription
getExternalUrl ()Specifies the external URL. Read-only String.

Returns: String


getExternalUrlOriginal

NameDescription
getExternalUrlOriginal ()Represents a hyperlink that is set for this portion without regard to the actual content of the portion. PowerPoint behaves specifically for links and their corresponding text in a portion. It allows to create text for the hyperlink in the form of a valid URL, different from the real address of the link. In this case, when you view the link in the edit window, it will be changed to match the text portion. This property represents the original value of the hyperlink.

Returns: String


getFirstSlide

NameDescription
getFirstSlide ()Returns a hyperlink to the first slide of the presentation. Read-only Hyperlink.

Returns: Hyperlink


getHighlightClick

NameDescription
getHighlightClick ()Determines whether the hyperlink should be highlighted on click. Read/write boolean.

Returns: boolean


getHistory

NameDescription
getHistory ()Determines whether the target of the parent hyperlink shall be added to a list of viewed hyperlinks when it is invoked. Read/write boolean.

Returns: boolean


getLastSlide

NameDescription
getLastSlide ()Returns a hyperlink to the last slide of the presentation. Read-only Hyperlink.

Returns: Hyperlink


getLastVievedSlide

NameDescription
getLastVievedSlide ()Returns a hyperlink to the last viewed slide. Read-only Hyperlink.

Returns: Hyperlink


getMedia

NameDescription
getMedia ()Returns a special “play mediafile” hyperlink. Used in AudioFrame and VideoFrame. Read-only Hyperlink.

Returns: Hyperlink


getNextSlide

NameDescription
getNextSlide ()Returns a hyperlink to the next slide. Read-only Hyperlink.

Returns: Hyperlink


getNoAction

NameDescription
getNoAction ()Returns a special “do nothing” hyperlink. Read-only Hyperlink.

Returns: Hyperlink


getPreviousSlide

NameDescription
getPreviousSlide ()Returns a hyperlink to the previous slide. Read-only Hyperlink.

Returns: Hyperlink


getSound

NameDescription
getSound ()Represents the playing sound of the hyperlink. Read/write IAudio.

Returns: Audio


getStopSoundOnClick

NameDescription
getStopSoundOnClick ()Determines whether the sound should be stopped on hyperlink click. Read/write boolean.

Returns: boolean


getTargetFrame

NameDescription
getTargetFrame ()Returns the frame within the parent HTML frameset for the target of the parent hyperlink when one exists. Read/wite String.

Returns: String


getTargetSlide

NameDescription
getTargetSlide ()If the Hyperlink targets specific slide returns this slide. Read-only ISlide.

Returns: Slide


getTooltip

NameDescription
getTooltip ()Returns the string which may be surfaced in a user interface as associated with the parent hyperlink. Read/write String.

Returns: String


getVersion

NameDescription
getVersion ()

Returns: long


hashCode

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

Returns: int


op_Equality

NameDescription
op_Equality (Hyperlink, Hyperlink)Tests two hyperlinks for equality.

Parameters:

NameTypeDescription
hlink1HyperlinkFirst hyperlink to be tested.
hlink2HyperlinkSecond hyperlink to be tested.

Returns: boolean


op_Inequality

NameDescription
op_Inequality (Hyperlink, Hyperlink)Tests two hyperlinks for inequality.

Parameters:

NameTypeDescription
hlink1HyperlinkFirst hyperlink to be tested.
hlink2HyperlinkSecond hyperlink to be tested.

Returns: boolean


setColorSource

NameDescription
setColorSource (int)Represents the source of hyperlink color - either styles or portion format. Read/write HyperlinkColorSource.

Returns: void


setHighlightClick

NameDescription
setHighlightClick (boolean)Determines whether the hyperlink should be highlighted on click. Read/write boolean.

Returns: void


setHistory

NameDescription
setHistory (boolean)Determines whether the target of the parent hyperlink shall be added to a list of viewed hyperlinks when it is invoked. Read/write boolean.

Returns: void


setSound

NameDescription
setSound (Audio)Represents the playing sound of the hyperlink. Read/write IAudio.

Returns: void


setStopSoundOnClick

NameDescription
setStopSoundOnClick (boolean)Determines whether the sound should be stopped on hyperlink click. Read/write boolean.

Returns: void


setTargetFrame

NameDescription
setTargetFrame (String)Returns the frame within the parent HTML frameset for the target of the parent hyperlink when one exists. Read/wite String.

Returns: void


setTooltip

NameDescription
setTooltip (String)Returns the string which may be surfaced in a user interface as associated with the parent hyperlink. Read/write String.

Returns: void