Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class Hyperlinks

java.lang.Object
  extended by com.aspose.cells.Hyperlinks

public class Hyperlinks
extends java.lang.Object

Encapsulates a collection of Hyperlink objects.


Method Summary
 int add(CellArea cellArea, java.lang.String address, java.lang.String screenTip, java.lang.String textToDisplay)
          Adds a hyperlink to a specified cell or a range of cells.
 int add(int startRow, int startColumn, int endRow, int endColumn, java.lang.String address, java.lang.String screenTip, java.lang.String textToDisplay)
          Adds a hyperlink to a specified cell or a range of cells.
 int add(java.lang.String startCellName, int rowNumber, int columnNumber, java.lang.String address, java.lang.String screenTip, java.lang.String textToDisplay)
          Adds a hyperlink to a specified cell or a range of cells.
 int add(java.lang.String startCellName, java.lang.String endCellName, java.lang.String address, java.lang.String screenTip, java.lang.String textToDisplay)
          Adds a hyperlink to a specified cell or a range of cells.
 void clear()
          Clears all hyper links.
 Hyperlink getHyperlink(int index)
          Gets Hyberlink object by index.
 int size()
          Gets number of the Hyberlink objects.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

add

public int add(int startRow,
               int startColumn,
               int endRow,
               int endColumn,
               java.lang.String address,
               java.lang.String screenTip,
               java.lang.String textToDisplay)
Adds a hyperlink to a specified cell or a range of cells.

Parameters:
startRow - row index of the top left cell.
startColumn - column index of the top left cell.
endRow - row index of the bottom right cell.
endColumn - column index of the bottom right cell.
address - address of this hyperlink.
screenTip - screen tip to be displayed when the mouse pointer is paused over the hyperlink.
textToDisplay - text to be displayed for the hyperlink.
Returns:
Hyperlink object index.
Throws:
java.lang.IllegalArgumentException - if cell range index is invalid or the address is empty.
CellsException - if the hyperlinks has been removed from the worksheet.

add

public int add(java.lang.String startCellName,
               java.lang.String endCellName,
               java.lang.String address,
               java.lang.String screenTip,
               java.lang.String textToDisplay)
Adds a hyperlink to a specified cell or a range of cells.

Parameters:
startCellName - start cell name of this hyperlink range.
endCellName - end cell name of this hyperlink range.
address - address of this hyperlink.This parameter can't be empty.
screenTip - screen tip to be displayed when the mouse pointer is paused over the hyperlink.
textToDisplay - text to be displayed for the hyperlink.
Returns:
Hyperlink object index.
Throws:
java.lang.IllegalArgumentException - if the address is empty or cell name is invalid.
CellsException - if the hyperlinks has been removed from the worksheet.

add

public int add(java.lang.String startCellName,
               int rowNumber,
               int columnNumber,
               java.lang.String address,
               java.lang.String screenTip,
               java.lang.String textToDisplay)
Adds a hyperlink to a specified cell or a range of cells.

Parameters:
startCellName - start cell name of this hyperlink range.
rowNumber - number of rows in this hyperlink range.
columnNumber - number of columns in this hyperlink range.
address - address of this hyperlink.This parameter can't be empty.
screenTip - screen tip to be displayed when the mouse pointer is paused over the hyperlink.
textToDisplay - text to be displayed for the hyperlink.
Returns:
Hyperlink object index.
Throws:
java.lang.IllegalArgumentException - if the address is empty or cell name is invalid.
CellsException - if the hyperlinks has been removed from the worksheet.

add

public int add(CellArea cellArea,
               java.lang.String address,
               java.lang.String screenTip,
               java.lang.String textToDisplay)
Adds a hyperlink to a specified cell or a range of cells.

Parameters:
cellArea - hyperlink range.
address - address of this hyperlink.
screenTip - screen tip to be displayed when the mouse pointer is paused over the hyperlink.
textToDisplay - text to be displayed for the hyperlink.
Returns:
Hyperlink object index.
Throws:
java.lang.IllegalArgumentException - if the address is empty.
CellsException - if the hyperlinks has been removed from the worksheet.

getHyperlink

public Hyperlink getHyperlink(int index)
Gets Hyberlink object by index.

Parameters:
index - Hyperlink object index.
Returns:
Hyberlink object.
Throws:
java.lang.IllegalArgumentException - if hyperlink index is out of range.
CellsException - if the hyperlinks has been removed from the worksheet.

size

public int size()
Gets number of the Hyberlink objects.

Returns:
Number of the Hyberlink objects.

clear

public void clear()
Clears all hyper links.