Method Details

• get

  IHyperlink get(int index)

  Gets the IHyperlink by index.

  The index is zero-based. If the index is outside the collection, this method returns null.

  
   IHyperlinks hyperlinks = worksheet.getHyperlinks();
   hyperlinks.add(worksheet.getRange("A1"), "https://www.example.com");
   IHyperlink hyperlink = hyperlinks.get(0);
   

  Parameters:

  index - The zero-based index of the hyperlink.

  Returns:

  The IHyperlink object at the specified index, or null if the index is outside the collection.

• getCount

  int getCount()

  Returns the number of objects in the collection.

  For an IHyperlinks collection, this value indicates how many IHyperlink objects are contained in the worksheet or range.

  
   IRange range = worksheet.getRange("A1:A2");
   range.getHyperlinks().add(worksheet.getRange("A1"), "https://www.example.com");
   int count = range.getHyperlinks().getCount();
   

  Returns:

  The number of IHyperlink objects in the collection.

• add

  IHyperlink add(IRange anchor, String address)

  Adds a hyperlink to the specified range ( IHyperlink object).

  Use this method to attach a hyperlink to the specified anchor range.

  
   IHyperlinks hyperlinks = worksheet.getHyperlinks();
   worksheet.getRange("A1").setValue("Example");
   IHyperlink hyperlink = hyperlinks.add(worksheet.getRange("A1"), "https://www.example.com");
   

  Parameters:

  anchor - The IRange that serves as the hyperlink anchor. Must not be null.

  address - The hyperlink address. Must not be null.

  Returns:

  The added IHyperlink object.

• add

  IHyperlink add(IRange anchor, String address, String subAddress, String screenTip, String textToDisplay)

  Adds a hyperlink to the specified range ( IHyperlink object).

  Use this overload to specify the hyperlink address together with an optional subaddress, screen tip, and display text.

  
   IRange range = worksheet.getRange("A1:A2");
   IHyperlink hyperlink = range.getHyperlinks().add(
       worksheet.getRange("A1"),
       "https://www.example.com",
       null,
       "Open example",
       "Example");
   

  Parameters:

  anchor - The IRange that serves as the anchor for the hyperlink.

  address - The hyperlink address. This value can be null when the target is specified by subAddress.

  subAddress - The subaddress of the hyperlink. This value is optional and can be null.

  screenTip - The screen tip displayed when the mouse pointer pauses over the hyperlink. This value is optional and can be null.

  textToDisplay - The text displayed for the hyperlink. Pass an empty string to use the default display text.

  Returns:

  The added IHyperlink object.

• add

  IHyperlink add(IShape shape, String address)

  Adds a hyperlink to the specified shape ( IHyperlink object).

  Use this method to attach a hyperlink address to a shape on the worksheet.

  
   IShape shape = worksheet.getShapes().addShape(AutoShapeType.Oval, 10, 10, 120, 60);
   shape.getTextFrame().getTextRange().add("Example");
   IHyperlink hyperlink = worksheet.getHyperlinks().add(shape, "https://www.example.com");
   

  Parameters:

  shape - The IShape for the hyperlink.

  address - The address of the hyperlink.

  Returns:

  The created IHyperlink object.

• add

  IHyperlink add(IShape shape, String address, String subAddress, String screenTip, String textToDisplay)

  Adds a hyperlink to the specified shape ( IHyperlink object).

  Use this method to attach a hyperlink to a shape such as an auto shape, chart, connector, picture, or group shape. The hyperlink target is defined by address and subAddress, and the optional screen tip and display text can be used to customize the user-facing content.

  
   IShape shape = worksheet.getShapes().addShape(AutoShapeType.Oval, 10, 10, 120, 40);
   IHyperlinks hyperlinks = worksheet.getHyperlinks();
   IHyperlink hyperlink = hyperlinks.add(
       shape, "https://www.example.com", null, "Open example", "Example");
   

  Parameters:

  shape - The shape for the hyperlink.

  address - The hyperlink address. This value can be null when the target is specified by subAddress.

  subAddress - The location within the target document. This value can be null.

  screenTip - The screen tip displayed when the mouse pointer pauses over the hyperlink. This value can be null.

  textToDisplay - The text to be displayed for the hyperlink. Pass an empty string to use the default display text.

  Returns:

  The added IHyperlink object.

• delete

  void delete()

  Deletes the hyperlinks in this collection.

  When this collection belongs to a worksheet, this method deletes all hyperlinks in the worksheet. When it belongs to a range, this method deletes the hyperlinks in that range.

  
   IRange range = worksheet.getRange("A1:A2");
   range.getHyperlinks().add(worksheet.getRange("A1"), "https://www.example.com", null, "Open example", "Example");
   range.getHyperlinks().delete();