aspose.cells
Class Hyperlink

Encapsulates the object that represents a hyperlink.

Example:

//Instantiating a Workbook object
//Instantiating a Workbook object
$workbook = new cells\Workbook();
//Adding a new worksheet to the Workbook object
$workbook->getWorksheets()->add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
$worksheet = $workbook->getWorksheets()->get(0);
//Adding a hyperlink to a URL at "A1" cell
$worksheet->getHyperlinks()->add("A1", 1, 1, "http://www.aspose.com");

Property Getters/Setters Summary
functiongetAddress()
functionsetAddress(value)
           Represents the address of a hyperlink.
functiongetArea()
           Gets the range of hyperlink.
functiongetLinkType()
           Gets the link type. The value of the property is TargetModeType integer constant.
functiongetScreenTip()
functionsetScreenTip(value)
           Returns or sets the ScreenTip text for the specified hyperlink.
functiongetTextToDisplay()
functionsetTextToDisplay(value)
           Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.
 
Method Summary
functiondelete()
           Deletes this hyperlink
 

Property Getters/Setters Detail

getAddress/setAddress : String 

function getAddress() / function setAddress(value)
Represents the address of a hyperlink.

getTextToDisplay/setTextToDisplay : String 

function getTextToDisplay() / function setTextToDisplay(value)
Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.

getArea : CellArea 

function getArea()
Gets the range of hyperlink.

getScreenTip/setScreenTip : String 

function getScreenTip() / function setScreenTip(value)
Returns or sets the ScreenTip text for the specified hyperlink.

getLinkType : Number 

function getLinkType()
Gets the link type. The value of the property is TargetModeType integer constant.

Method Detail

delete

function delete()
Deletes this hyperlink

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.