IHyperlink

public interface IHyperlink

Represents a hyperlink.

Methods

Method	Description
getActionType()	Returns type of HyperLinkEx’s action.
getExternalUrl()	Specifies the external URL If this property become not null then property TargetSlide become null.
getExternalUrlOriginal()	Represents a hyperlink that is set for this portion without regard to the actual content of the portion.
getTargetSlide()	If the HyperlinkEx targets specific slide returns this slide.
getTargetFrame()	Returns the frame within the parent HTML frameset for the target of the parent hyperlink when one exists.
setTargetFrame(String value)	Returns the frame within the parent HTML frameset for the target of the parent hyperlink when one exists.
getTooltip()	Returns the string which may be surfaced in a user interface as associated with the parent hyperlink.
setTooltip(String value)	Returns the string which may be surfaced in a user interface as associated with the parent hyperlink.
getHistory()	Determines whether the target of the parent hyperlink shall be added to a list of viewed hyperlinks when it is invoked.
setHistory(boolean value)	Determines whether the target of the parent hyperlink shall be added to a list of viewed hyperlinks when it is invoked.
getHighlightClick()	Determines whether the hyperlink should be highlighted on click.
setHighlightClick(boolean value)	Determines whether the hyperlink should be highlighted on click.
getStopSoundOnClick()	Determines whether the sound should be stopped on hyperlink click.
setStopSoundOnClick(boolean value)	Determines whether the sound should be stopped on hyperlink click.
getSound()	Represents the playing sound of the hyperlink.
setSound(IAudio value)	Represents the playing sound of the hyperlink.
getColorSource()	Represents the source of hyperlink color - either styles or portion format.
setColorSource(int value)	Represents the source of hyperlink color - either styles or portion format.
equals(IHyperlink hlink)	Determines whether the two Hyperlink instances are equal.

getActionType()

public abstract int getActionType()

Returns type of HyperLinkEx’s action. Read-only HyperlinkActionType.

Returns: int

getExternalUrl()

public abstract String getExternalUrl()

Specifies the external URL If this property become not null then property TargetSlide become null. Read-only String.

Returns: java.lang.String

getExternalUrlOriginal()

public abstract 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.

Returns: java.lang.String

getTargetSlide()

public abstract ISlide getTargetSlide()

If the HyperlinkEx targets specific slide returns this slide. If the property become not null then property ExternalUrl become null. Read-only ISlide.

Returns: ISlide

getTargetFrame()

public abstract String getTargetFrame()

Returns the frame within the parent HTML frameset for the target of the parent hyperlink when one exists. Read/write String.

Returns: java.lang.String

setTargetFrame(String value)

public abstract void setTargetFrame(String value)

Returns the frame within the parent HTML frameset for the target of the parent hyperlink when one exists. Read/write String.

Parameters:

Parameter	Type	Description
value	java.lang.String

getTooltip()

public abstract String getTooltip()

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

Returns: java.lang.String

setTooltip(String value)

public abstract void setTooltip(String value)

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

Parameters:

Parameter	Type	Description
value	java.lang.String

getHistory()

public abstract 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.

Returns: boolean

setHistory(boolean value)

public abstract 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.

Parameters:

Parameter	Type	Description
value	boolean

getHighlightClick()

public abstract boolean getHighlightClick()

Determines whether the hyperlink should be highlighted on click. Read/write boolean.

Returns: boolean

setHighlightClick(boolean value)

public abstract void setHighlightClick(boolean value)

Determines whether the hyperlink should be highlighted on click. Read/write boolean.

Parameters:

Parameter	Type	Description
value	boolean

getStopSoundOnClick()

public abstract boolean getStopSoundOnClick()

Determines whether the sound should be stopped on hyperlink click. Read/write boolean.

Returns: boolean

setStopSoundOnClick(boolean value)

public abstract void setStopSoundOnClick(boolean value)

Determines whether the sound should be stopped on hyperlink click. Read/write boolean.

Parameters:

Parameter	Type	Description
value	boolean

getSound()

public abstract 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();
 }

Returns: IAudio

setSound(IAudio value)

public abstract 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();
 }

Parameters:

Parameter	Type	Description
value	IAudio

getColorSource()

public abstract int getColorSource()

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

Returns: int

setColorSource(int value)

public abstract void setColorSource(int value)

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

Parameters:

Parameter	Type	Description
value	int

equals(IHyperlink hlink)

public abstract boolean equals(IHyperlink hlink)

Determines whether the two Hyperlink instances are equal.

Parameters:

Parameter	Type	Description
hlink	IHyperlink	The Hyperlink to compare with the current Hyperlink.

Returns: boolean - true if the specified Hyperlink is equal to the current Hyperlink; otherwise, false.