public class Hyperlink extends PVIObject implements IHyperlink
Represents a hyperlink.
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.
|
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.
|
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.
|
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.
|
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 |
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.
|
getParent_IPresentationComponent, getParent_ISlideComponent, getPresentation, getSlide, getVersion, reset_Parent_IPresentationComponent
public Hyperlink(java.lang.String url)
Creates an instance of a hyperlink.
url
- Hyperlink URL.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.
slide
- Target slide.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.
source
- Source hyperlinktargetFrame
- Target frametooltip
- Tooltip texthistory
- 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.public static Hyperlink getNoAction()
Returns a special "do nothing" hyperlink.
Read-only Hyperlink
.
public static Hyperlink getMedia()
Returns a special "play mediafile" hyperlink. Used in AudioFrame and VideoFrame.
Read-only Hyperlink
.
public static Hyperlink getNextSlide()
Returns a hyperlink to the next slide.
Read-only Hyperlink
.
public static Hyperlink getPreviousSlide()
Returns a hyperlink to the previous slide.
Read-only Hyperlink
.
public static Hyperlink getFirstSlide()
Returns a hyperlink to the first slide of the presentation.
Read-only Hyperlink
.
public static Hyperlink getLastSlide()
Returns a hyperlink to the last slide of the presentation.
Read-only Hyperlink
.
public static Hyperlink getLastVievedSlide()
Returns a hyperlink to the last viewed slide.
Read-only Hyperlink
.
public static Hyperlink getEndShow()
Returns a hyperlink which ends the show.
Read-only Hyperlink
.
public final int getActionType()
Returns type of Hyperlink's action.
Read-only HyperlinkActionType
.
getActionType
in interface IHyperlink
public final java.lang.String getExternalUrl()
Specifies the external URL.
Read-only String
.
getExternalUrl
in interface IHyperlink
public final ISlide getTargetSlide()
If the Hyperlink targets specific slide returns this slide.
Read-only ISlide
.
getTargetSlide
in interface IHyperlink
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
.
getTargetFrame
in interface IHyperlink
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
.
setTargetFrame
in interface IHyperlink
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
.
getTooltip
in interface IHyperlink
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
.
setTooltip
in interface IHyperlink
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
.
getHistory
in interface IHyperlink
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
.
setHistory
in interface IHyperlink
public final boolean getHighlightClick()
Determines whether the hyperlink should be highlighted on click.
Read/write boolean
.
getHighlightClick
in interface IHyperlink
public final void setHighlightClick(boolean value)
Determines whether the hyperlink should be highlighted on click.
Read/write boolean
.
setHighlightClick
in interface IHyperlink
public final boolean getStopSoundOnClick()
Determines whether the sound should be stopped on hyperlink click.
Read/write boolean
.
getStopSoundOnClick
in interface IHyperlink
public final void setStopSoundOnClick(boolean value)
Determines whether the sound should be stopped on hyperlink click.
Read/write boolean
.
setStopSoundOnClick
in interface IHyperlink
public final int getColorSource()
Represents the source of hyperlink color - either styles or portion format.
Read/write HyperlinkColorSource
.
getColorSource
in interface IHyperlink
public final void setColorSource(int value)
Represents the source of hyperlink color - either styles or portion format.
Read/write HyperlinkColorSource
.
setColorSource
in interface IHyperlink
public boolean equals(java.lang.Object obj)
Determines whether the two Hyperlink instances are equal.
public final boolean equals(IHyperlink hlink)
Determines whether the two Hyperlink instances are equal.
equals
in interface IHyperlink
hlink
- The Hyperlink to compare with the current Hyperlink.<b>true</b>
if the specified Hyperlink is equal to the current Hyperlink; otherwise, <b>false</b>
.public static boolean op_Equality(Hyperlink hlink1, Hyperlink hlink2)
Tests two hyperlinks for equality.
hlink1
- First hyperlink to be tested.hlink2
- Second hyperlink to be tested.<b>True</b>
if hyperlinks are equal.public static boolean op_Inequality(Hyperlink hlink1, Hyperlink hlink2)
Tests two hyperlinks for inequality.
hlink1
- First hyperlink to be tested.hlink2
- Second hyperlink to be tested.<b>False</b>
if hyperlinks are equal.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.
public final com.aspose.slides.IDOMObject getParent_Immediate()
Returns Parent_Immediate object.
Read-only IDOMObject
.
getParent_Immediate
in class PVIObject