Package com.grapecity.documents.excel

Interface IHyperlink

public interface IHyperlink
Represents a hyperlink.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete()
    Deletes the hyperlink.
    String
    getAddress()
    Gets the address of the target document.
    String
    getEmailSubject()
    Gets the text string of the specified hyperlink’s e-mail subject line.
    String
    getName()
    Returns the name of the object.
    IRange
    getRange()
    Returns the IRange object that represents the range the specifiedhyperlink is attached to.
    String
    getScreenTip()
    Gets the ScreenTip text for the specified hyperlink.
    IShape
    getShape()
    Returns the IShape object that represents the shape attached to the specified hyperlink.
    String
    getSubAddress()
    Gets the location within the document associated with the hyperlink.
    String
    getTextToDisplay()
    Gets the text to be displayed for the specified hyperlink.
    void
    setAddress(String value)
    Sets the address of the target document.
    void
    setEmailSubject(String value)
    Sets the text string of the specified hyperlink’s e-mail subject line.
    void
    setScreenTip(String value)
    Sets the ScreenTip text for the specified hyperlink.
    void
    setSubAddress(String value)
    Sets the location within the document associated with the hyperlink.
    void
    setTextToDisplay(String value)
    Sets the text to be displayed for the specified hyperlink.

  • Method Details

    • getName

      String getName()
      Returns the name of the object.

    • getRange

      IRange getRange()
      Returns the IRange object that represents the range the specifiedhyperlink is attached to.

    • getShape

      IShape getShape()
      Returns the IShape object that represents the shape attached to the specified hyperlink.

    • getAddress

      String getAddress()
      Gets the address of the target document.

    • setAddress

      void setAddress(String value)
      Sets the address of the target document.

    • getEmailSubject

      String getEmailSubject()
      Gets the text string of the specified hyperlink’s e-mail subject line. The subject line is appended to the hyperlink’s address.

    • setEmailSubject

      void setEmailSubject(String value)
      Sets the text string of the specified hyperlink’s e-mail subject line. The subject line is appended to the hyperlink’s address.

    • getScreenTip

      String getScreenTip()
      Gets the ScreenTip text for the specified hyperlink.

    • setScreenTip

      void setScreenTip(String value)
      Sets the ScreenTip text for the specified hyperlink.

    • getSubAddress

      String getSubAddress()
      Gets the location within the document associated with the hyperlink.

    • setSubAddress

      void setSubAddress(String value)
      Sets the location within the document associated with the hyperlink.

    • getTextToDisplay

      String getTextToDisplay()
      Gets the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.

    • setTextToDisplay

      void setTextToDisplay(String value)
      Sets the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.

    • delete

      void delete()
      Deletes the hyperlink.