com.aspose.slides

Interfaces

Classes

Exceptions

Skip navigation links
com.aspose.slides

Interface IHyperlink

  • All Known Implementing Classes:
    Hyperlink

    public interface IHyperlink

    Represents a hyperlink.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      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.
      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.
      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 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.

      • getTargetSlide

        ISlide getTargetSlide()

        If the HyperlinkEx targets specific slide returns this slide. If ths 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.

      • 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:
        <b>true</b> if the specified Hyperlink is equal to the current Hyperlink; otherwise, <b>false</b>.