Package com.grapecity.documents.excel

Interface IHyperlinks

All Superinterfaces:
Iterable<IHyperlink>
public interface IHyperlinks extends Iterable<IHyperlink>
Represents the collection of hyperlinks for a worksheet or range. Each hyperlink is represented by the IHyperlink object.

  • Method Details

    • get

      IHyperlink get(int index)
      Gets the IHyperlink by index.
      Parameters:
      index - The index of the collection.
      Returns:
      Returns the IHyperlink object.

    • getCount

      int getCount()
      Returns the number of objects in the collection.

    • add

      IHyperlink add(IRange anchor, String address)
      Adds a hyperlink to the specified range ( IHyperlink object).
      Parameters:
      anchor - Required IRangeThe anchor for the hyperlink.
      address - Required String. The address of the hyperlink.

    • add

      IHyperlink add(IRange anchor, String address, String subAddress, String screenTip, String textToDisplay)
      Adds a hyperlink to the specified range ( IHyperlink object).
      Parameters:
      anchor - Required IRangeThe anchor for the hyperlink.
      address - Required String. The address of the hyperlink.
      subAddress - Optional Object. The subaddress of the hyperlink.
      screenTip - Optional Object. The screen tip to be displayed when the mousepointer is paused over the hyperlink.
      textToDisplay - Optional Object. The text to be displayed for the hyperlink.

    • add

      IHyperlink add(IShape shape, String address)
      Adds a hyperlink to the specified shape ( IHyperlink object).
      Parameters:
      shape - Required IShapeThe shape for the hyperlink.
      address - Required String. The address of the hyperlink.

    • add

      IHyperlink add(IShape shape, String address, String subAddress, String screenTip, String textToDisplay)
      Adds a hyperlink to the specified shape ( IHyperlink object).
      Parameters:
      shape - Required IRangeThe shape for the hyperlink.
      address - Required String. The address of the hyperlink.
      subAddress - Optional Object. The subaddress of the hyperlink.
      screenTip - Optional Object. The screen tip to be displayed when the mousepointer is paused over the hyperlink.
      textToDisplay - Optional Object. The text to be displayed for the hyperlink.

    • delete

      void delete()
      Deletes the object.