Hyperlink
Contents
[
Hide
]Hyperlink class
Encapsulates the object that represents a hyperlink.
class Hyperlink;
Methods
| Method | Description |
|---|---|
| getAddress() | Represents the address of a hyperlink. |
| setAddress(string) | Represents the address of a hyperlink. |
| getTextToDisplay() | Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink. |
| setTextToDisplay(string) | Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink. |
| getArea() | Gets the range of hyperlink. |
| getScreenTip() | Returns or sets the ScreenTip text for the specified hyperlink. |
| setScreenTip(string) | Returns or sets the ScreenTip text for the specified hyperlink. |
| getLinkType() | Gets the link type. |
| delete() | Deletes this hyperlink |
getAddress()
Represents the address of a hyperlink.
getAddress() : string;
setAddress(string)
Represents the address of a hyperlink.
setAddress(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getTextToDisplay()
Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.
getTextToDisplay() : string;
setTextToDisplay(string)
Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.
setTextToDisplay(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getArea()
Gets the range of hyperlink.
getArea() : CellArea;
Returns
getScreenTip()
Returns or sets the ScreenTip text for the specified hyperlink.
getScreenTip() : string;
setScreenTip(string)
Returns or sets the ScreenTip text for the specified hyperlink.
setScreenTip(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getLinkType()
Gets the link type.
getLinkType() : TargetModeType;
Returns
delete()
Deletes this hyperlink
delete() : void;