com.aspose.slides

Interface IHyperlink

All Known Implementing Classes:

Hyperlink

public interface IHyperlink

Represents a hyperlink.

Method Summary

Modifier and Type	Method and Description
boolean	equals(IHyperlink hlink) Determines whether the two Hyperlink instances are equal.
int	getActionType() Returns type of HyperLinkEx's action.
int	getColorSource() Represents the source of hyperlink color - either styles or portion format.
java.lang.String	getExternalUrl() Specifies the external URL If this property become not null then property TargetSlide become null.
java.lang.String	getExternalUrlOriginal() Represents a hyperlink that is set for this portion without regard to the actual content of the portion.
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.
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 HyperlinkEx 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.
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.

Method Detail

getActionType

int getActionType()

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

getExternalUrl

java.lang.String getExternalUrl()

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

getExternalUrlOriginal

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.

getTargetSlide

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.

getTargetFrame

java.lang.String getTargetFrame()

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

setTargetFrame

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/write String.

getTooltip

java.lang.String getTooltip()

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

setTooltip

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.

getHistory

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.

setHistory

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.

getHighlightClick

boolean getHighlightClick()

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

setHighlightClick

void setHighlightClick(boolean value)

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

getStopSoundOnClick

boolean getStopSoundOnClick()

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

setStopSoundOnClick

void setStopSoundOnClick(boolean value)

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

getSound

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

setSound

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

getColorSource

int getColorSource()

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

setColorSource

void setColorSource(int value)

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

equals

boolean equals(IHyperlink hlink)

Determines whether the two Hyperlink instances are equal.

Parameters:

hlink - The Hyperlink to compare with the current Hyperlink.

Returns:

true if the specified Hyperlink is equal to the current Hyperlink; otherwise, false.