asposecells.api

asposecells.api

Class Hyperlink

Encapsulates the object that represents a hyperlink.

Example:

# Instantiating a Workbook object
workbook = 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")
# Saving the Excel file
workbook.save("Book1.xls")

Property Getters/Setters Summary
methodgetAddress()
method
setAddress(value)
           Represents the address of a hyperlink.
methodgetArea()
Gets the range of hyperlink.
methodgetLinkType()
Gets the link type. The value of the property is TargetModeType integer constant.
methodgetScreenTip()
method
setScreenTip(value)
           Returns or sets the ScreenTip text for the specified hyperlink.
methodgetTextToDisplay()
method
setTextToDisplay(value)
           Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.
 
Method Summary
methoddelete()
Deletes this hyperlink
 

    • Property Getters/Setters Detail

      • getAddress/setAddress : String 

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

      • getTextToDisplay/setTextToDisplay : String 

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

      • getScreenTip/setScreenTip : String 

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

      • getLinkType : int 

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

    • Method Detail

      • delete

         delete()
        Deletes this hyperlink