Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class Hyperlink

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

public class Hyperlink
extends java.lang.Object

Encapsulates the object that represents a hyperlink.


Method Summary
 java.lang.String getAddress()
          Gets the address of the hyperlink
 CellArea getCellArea()
          Gets cell range of all cells containing the hyperlink.
 java.lang.String getScreenTip()
          Gets screen tip of the hyperlink.
 java.lang.String getTextToDisplay()
          Gets text to be displayed for the hyperlink.
 void setAddress(java.lang.String address)
          Sets the address of the hyperlink.
 void setScreenTip(java.lang.String screenTip)
          Sets screen tip of the hyperlink.
 void setTextToDisplay(java.lang.String textToDisplay)
          Sets text to be displayed for the hyperlink.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getAddress

public java.lang.String getAddress()
Gets the address of the hyperlink

Returns:
address of the hyperlink.

setAddress

public void setAddress(java.lang.String address)
Sets the address of the hyperlink.

Parameters:
address - address of the hyperlink.This parameter can't be empty.
Throws:
java.lang.IllegalArgumentException - if the address is empty.
CellsException - if the hyperlink has been removed from the hyperlinks.

getCellArea

public CellArea getCellArea()
Gets cell range of all cells containing the hyperlink.

Returns:
cell range of all cells containing the hyperlink.

getScreenTip

public java.lang.String getScreenTip()
Gets screen tip of the hyperlink.

Returns:
screen tip to be displayed when the mouse pointer is paused over the hyperlink.

setScreenTip

public void setScreenTip(java.lang.String screenTip)
Sets screen tip of the hyperlink.

Parameters:
screenTip - screen tip to be displayed when the mouse pointer is paused over the hyperlink.
Throws:
CellsException - if the hyperlink has been removed from the hyperlinks.

getTextToDisplay

public java.lang.String getTextToDisplay()
Gets text to be displayed for the hyperlink.

Returns:
text to be displayed for the hyperlink.

setTextToDisplay

public void setTextToDisplay(java.lang.String textToDisplay)
Sets text to be displayed for the hyperlink.

Parameters:
textToDisplay - text to be displayed for the hyperlink.
Throws:
CellsException - if the hyperlink has been removed from the hyperlinks.