com.aspose.cells

Class Hyperlink

java.lang.Object

com.aspose.cells.Hyperlink

public class Hyperlink
extends java.lang.Object

Encapsulates the object that represents a hyperlink.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new 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 worksheet = workbook.getWorksheets().get(0);
         //Adding a hyperlink to a URL at "A1" cell
         int index = worksheet.getHyperlinks().add("A1", 1, 1, "http://www.aspose.com");
         //Getting a Hyperlink by index.
         Hyperlink hyperlink = worksheet.getHyperlinks().get(index);
         //Setting display text of this hyperlink.
         hyperlink.setTextToDisplay("Aspose");
         //Saving the Excel file
         workbook.save("book1.xls");
 

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() Deletes this hyperlink
java.lang.String	getAddress() Represents the address of a hyperlink.
CellArea	getArea() Gets the range of hyperlink.
int	getLinkType() Gets the link type.
java.lang.String	getScreenTip() Returns or sets the ScreenTip text for the specified hyperlink.
java.lang.String	getTextToDisplay() Represents the text to be displayed for the specified hyperlink.
void	setAddress(java.lang.String value) Represents the address of a hyperlink.
void	setScreenTip(java.lang.String value) Returns or sets the ScreenTip text for the specified hyperlink.
void	setTextToDisplay(java.lang.String value) Represents the text to be displayed for the specified hyperlink.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAddress

public java.lang.String getAddress()

Represents the address of a hyperlink.

setAddress

public void setAddress(java.lang.String value)

Represents the address of a hyperlink.

getTextToDisplay

public java.lang.String getTextToDisplay()

Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.

setTextToDisplay

public void setTextToDisplay(java.lang.String value)

Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.

getArea

public CellArea getArea()

Gets the range of hyperlink.

getScreenTip

public java.lang.String getScreenTip()

Returns or sets the ScreenTip text for the specified hyperlink.

setScreenTip

public void setScreenTip(java.lang.String value)

Returns or sets the ScreenTip text for the specified hyperlink.

getLinkType

public int getLinkType()

Gets the link type.

See TargetModeType.

delete

public void delete()

Deletes this hyperlink