Hyperlink (Aspose.Slides for Java (25.10) API Documentation)

java.lang.Object
- com.aspose.slides.PVIObject
- - com.aspose.slides.Hyperlink

All Implemented Interfaces:

IHyperlink, IPresentationComponent, ISlideComponent
```
public final class Hyperlink
extends PVIObject
implements IHyperlink
```
Represents a hyperlink.

Constructor Summary

Constructors
Constructor and Description
`Hyperlink(Hyperlink source, java.lang.String targetFrame, java.lang.String tooltip, boolean history, boolean stopSoundsOnClick, boolean highlightClick)` Creates an instance of a hyperlink using another hyperlink as source, overriding secondary properties.
`Hyperlink(ISlide slide)` Creates an instance of a hyperlink which points to specific slide.
`Hyperlink(java.lang.String url)` Creates an instance of a hyperlink.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(IHyperlink hlink)` Determines whether the two Hyperlink instances are equal.
`boolean`	`equals(java.lang.Object obj)` Determines whether the two Hyperlink instances are equal.
`int`	`getActionType()` Returns type of Hyperlink's action.
`int`	`getColorSource()` Represents the source of hyperlink color - either styles or portion format.
`static Hyperlink`	`getEndShow()` Returns a hyperlink which ends the show.
`java.lang.String`	`getExternalUrl()` Specifies the external URL.
`java.lang.String`	`getExternalUrlOriginal()` Represents a hyperlink that is set for this portion without regard to the actual content of the portion.
`static Hyperlink`	`getFirstSlide()` Returns a hyperlink to the first slide of the presentation.
`boolean`	`getHighlightClick()` Determines whether the hyperlink should be highlighted on click.
`boolean`	`getHistory()` Determines whether the target of the parent hyperlink shall be added to a list of viewed hyperlinks when it is invoked.
`static Hyperlink`	`getLastSlide()` Returns a hyperlink to the last slide of the presentation.
`static Hyperlink`	`getLastVievedSlide()` Returns a hyperlink to the last viewed slide.
`static Hyperlink`	`getMedia()` Returns a special "play mediafile" hyperlink.
`static Hyperlink`	`getNextSlide()` Returns a hyperlink to the next slide.
`static Hyperlink`	`getNoAction()` Returns a special "do nothing" hyperlink.
`com.aspose.slides.IDOMObject`	`getParent_Immediate()` Returns Parent_Immediate object.
`static Hyperlink`	`getPreviousSlide()` Returns a hyperlink to the previous slide.
`IAudio`	`getSound()` Represents the playing sound of the hyperlink.
`boolean`	`getStopSoundOnClick()` Determines whether the sound should be stopped on hyperlink click.
`java.lang.String`	`getTargetFrame()` Returns the frame within the parent HTML frameset for the target of the parent hyperlink when one exists.
`ISlide`	`getTargetSlide()` If the Hyperlink targets specific slide returns this slide.
`java.lang.String`	`getTooltip()` Returns the string which may be surfaced in a user interface as associated with the parent hyperlink.
`long`	`getVersion()` Version.
`int`	`hashCode()` Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
`static boolean`	`op_Equality(Hyperlink hlink1, Hyperlink hlink2)` Tests two hyperlinks for equality.
`static boolean`	`op_Inequality(Hyperlink hlink1, Hyperlink hlink2)` Tests two hyperlinks for inequality.
`void`	`setColorSource(int value)` Represents the source of hyperlink color - either styles or portion format.
`void`	`setHighlightClick(boolean value)` Determines whether the hyperlink should be highlighted on click.
`void`	`setHistory(boolean value)` Determines whether the target of the parent hyperlink shall be added to a list of viewed hyperlinks when it is invoked.
`void`	`setSound(IAudio value)` Represents the playing sound of the hyperlink.
`void`	`setStopSoundOnClick(boolean value)` Determines whether the sound should be stopped on hyperlink click.
`void`	`setTargetFrame(java.lang.String value)` Returns the frame within the parent HTML frameset for the target of the parent hyperlink when one exists.
`void`	`setTooltip(java.lang.String value)` Returns the string which may be surfaced in a user interface as associated with the parent hyperlink.

Methods inherited from class com.aspose.slides.PVIObject
getParent_IPresentationComponent, getParent_ISlideComponent, getPresentation, getSlide

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Hyperlink
```
public Hyperlink(java.lang.String url)
```
    Creates an instance of a hyperlink.
    
    Parameters:
    
    url - Hyperlink URL.
  - Hyperlink
```
public Hyperlink(ISlide 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:
    
    slide - Target slide.
  - Hyperlink
```
public Hyperlink(Hyperlink source,
                 java.lang.String targetFrame,
                 java.lang.String tooltip,
                 boolean history,
                 boolean stopSoundsOnClick,
                 boolean highlightClick)
```
    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 - Determines whether the target of the parent hyperlink shall be added to a list of viewed hyperlinks when it is invoked.
    
    stopSoundsOnClick - Determines whether the sound should be stopped on hyperlink click.
    
    highlightClick - Determines whether the hyperlink should be highlighted on click.
- Method Detail
  - getVersion
```
public long getVersion()
```
    Version. Read-only long.
    
    Overrides:
    
    getVersion in class PVIObject
  - getNoAction
```
public static Hyperlink getNoAction()
```
    Returns a special "do nothing" hyperlink. Read-only Hyperlink.
  - getMedia
```
public static Hyperlink getMedia()
```
    Returns a special "play mediafile" hyperlink. Used in AudioFrame and VideoFrame. Read-only Hyperlink.
  - getNextSlide
```
public static Hyperlink getNextSlide()
```
    Returns a hyperlink to the next slide. Read-only Hyperlink.
  - getPreviousSlide
```
public static Hyperlink getPreviousSlide()
```
    Returns a hyperlink to the previous slide. Read-only Hyperlink.
  - getFirstSlide
```
public static Hyperlink getFirstSlide()
```
    Returns a hyperlink to the first slide of the presentation. Read-only Hyperlink.
  - getLastSlide
```
public static Hyperlink getLastSlide()
```
    Returns a hyperlink to the last slide of the presentation. Read-only Hyperlink.
  - getLastVievedSlide
```
public static Hyperlink getLastVievedSlide()
```
    Returns a hyperlink to the last viewed slide. Read-only Hyperlink.
  - getEndShow
```
public static Hyperlink getEndShow()
```
    Returns a hyperlink which ends the show. Read-only Hyperlink.
  - getActionType
```
public final int getActionType()
```
    Returns type of Hyperlink's action. Read-only HyperlinkActionType.
    
    Specified by:
    
    getActionType in interface IHyperlink
  - getExternalUrl
```
public final java.lang.String getExternalUrl()
```
    Specifies the external URL. Read-only String.
    
    Specified by:
    
    getExternalUrl in interface IHyperlink
  - getTargetSlide
```
public final ISlide getTargetSlide()
```
    If the Hyperlink targets specific slide returns this slide. Read-only ISlide.
    
    Specified by:
    
    getTargetSlide in interface IHyperlink
  - getExternalUrlOriginal
```
public final java.lang.String 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.
    
    Specified by:
    
    getExternalUrlOriginal in interface IHyperlink
  - getTargetFrame
```
public final java.lang.String getTargetFrame()
```
    Returns the frame within the parent HTML frameset for the target of the parent hyperlink when one exists. Read/wite String.
    
    Specified by:
    
    getTargetFrame in interface IHyperlink
  - setTargetFrame
```
public final void setTargetFrame(java.lang.String value)
```
    Returns the frame within the parent HTML frameset for the target of the parent hyperlink when one exists. Read/wite String.
    
    Specified by:
    
    setTargetFrame in interface IHyperlink
  - getTooltip
```
public final java.lang.String getTooltip()
```
    Returns the string which may be surfaced in a user interface as associated with the parent hyperlink. Read/write String.
    
    Specified by:
    
    getTooltip in interface IHyperlink
  - setTooltip
```
public final void setTooltip(java.lang.String value)
```
    Returns the string which may be surfaced in a user interface as associated with the parent hyperlink. Read/write String.
    
    Specified by:
    
    setTooltip in interface IHyperlink
  - getHistory
```
public final boolean 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.
    
    Specified by:
    
    getHistory in interface IHyperlink
  - setHistory
```
public final void setHistory(boolean value)
```
    Determines whether the target of the parent hyperlink shall be added to a list of viewed hyperlinks when it is invoked. Read/write boolean.
    
    Specified by:
    
    setHistory in interface IHyperlink
  - getHighlightClick
```
public final boolean getHighlightClick()
```
    Determines whether the hyperlink should be highlighted on click. Read/write boolean.
    
    Specified by:
    
    getHighlightClick in interface IHyperlink
  - setHighlightClick
```
public final void setHighlightClick(boolean value)
```
    Determines whether the hyperlink should be highlighted on click. Read/write boolean.
    
    Specified by:
    
    setHighlightClick in interface IHyperlink
  - getStopSoundOnClick
```
public final boolean getStopSoundOnClick()
```
    Determines whether the sound should be stopped on hyperlink click. Read/write boolean.
    
    Specified by:
    
    getStopSoundOnClick in interface IHyperlink
  - setStopSoundOnClick
```
public final void setStopSoundOnClick(boolean value)
```
    Determines whether the sound should be stopped on hyperlink click. Read/write boolean.
    
    Specified by:
    
    setStopSoundOnClick in interface IHyperlink
  - getSound
```
public final IAudio getSound()
```
    Represents the playing sound of the hyperlink. Read/write IAudio.
    Presentation presentation = new Presentation("demo.pptx"); try { ISlide slide = presentation.getSlides().get_Item(0); // Get the first shape hyperlink IHyperlink link = presentation.getSlides().get_Item(0).getShapes().get_Item(0).getHyperlinkClick(); if (link.getSound() != null) { // Extract the hyperlink sound in byte array byte[] audioData = link.getSound().getBinaryData(); } } finally { if (presentation != null) presentation.dispose(); }
    Specified by:
    
    getSound in interface IHyperlink
  - setSound
```
public final void setSound(IAudio value)
```
    Represents the playing sound of the hyperlink. Read/write IAudio.
    Presentation presentation = new Presentation("demo.pptx"); try { ISlide slide = presentation.getSlides().get_Item(0); // Get the first shape hyperlink IHyperlink link = presentation.getSlides().get_Item(0).getShapes().get_Item(0).getHyperlinkClick(); if (link.getSound() != null) { // Extract the hyperlink sound in byte array byte[] audioData = link.getSound().getBinaryData(); } } finally { if (presentation != null) presentation.dispose(); }
    Specified by:
    
    setSound in interface IHyperlink
  - getColorSource
```
public final int getColorSource()
```
    Represents the source of hyperlink color - either styles or portion format. Read/write HyperlinkColorSource.
    
    Specified by:
    
    getColorSource in interface IHyperlink
  - setColorSource
```
public final void setColorSource(int value)
```
    Represents the source of hyperlink color - either styles or portion format. Read/write HyperlinkColorSource.
    
    Specified by:
    
    setColorSource in interface IHyperlink
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Determines whether the two Hyperlink instances are equal.
    
    Overrides:
    
    equals in class PVIObject
    
    Parameters:
    
    obj - The Hyperlink to compare with the current Hyperlink.
    
    Returns:
    
    true if the specified Hyperlink is equal to the current Hyperlink; otherwise, false.
  - equals
```
public final boolean equals(IHyperlink hlink)
```
    Determines whether the two Hyperlink instances are equal.
    
    Specified by:
    
    equals in interface IHyperlink
    
    Parameters:
    
    hlink - The Hyperlink to compare with the current Hyperlink.
    
    Returns:
    
    true if the specified Hyperlink is equal to the current Hyperlink; otherwise, false.
  - op_Equality
```
public static boolean op_Equality(Hyperlink hlink1,
                                  Hyperlink 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(Hyperlink hlink1,
                                    Hyperlink 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 PVIObject
    
    Returns:
    
    Hash code for an URL.
  - getParent_Immediate
```
public final com.aspose.slides.IDOMObject getParent_Immediate()
```
    Returns Parent_Immediate object. Read-only IDOMObject.
    
    Overrides:
    
    getParent_Immediate in class PVIObject

Class Hyperlink

Constructor Summary

Method Summary

Methods inherited from class com.aspose.slides.PVIObject

Methods inherited from class java.lang.Object

Constructor Detail

Hyperlink

Hyperlink

Hyperlink

Method Detail

getVersion

getNoAction

getMedia

getNextSlide

getPreviousSlide

getFirstSlide

getLastSlide

getLastVievedSlide

getEndShow

getActionType

getExternalUrl

getTargetSlide

getExternalUrlOriginal

getTargetFrame

setTargetFrame

getTooltip

setTooltip

getHistory

setHistory

getHighlightClick

setHighlightClick

getStopSoundOnClick

setStopSoundOnClick

getSound

setSound

getColorSource

setColorSource

equals

equals

op_Equality

op_Inequality

hashCode

getParent_Immediate