Class Hyperlink

Implements

IHyperlink

Index

Constructors

Accessors

address history tgtFrame tooltip

Methods

Constructors

constructor

new Hyperlink(overrides): Hyperlink
Parameters
- overrides: Partial<HyperlinkValues>
Returns Hyperlink

Accessors

address

get address(): string
This can be a url or a cell address. Note - sheet address need to start with a #

Returns string
Implementation of IHyperlink.address

history

get history(): boolean
Specifies whether to add this URI to the history when navigating to it.

Returns boolean
Default Value
```
true
```
Implementation of IHyperlink.history

tgtFrame

get tgtFrame(): string
Specified the target frame when opening this Hyperlink.

Returns string
Default Value
```
newWindow
```
Implementation of IHyperlink.tgtFrame

tooltip

get tooltip(): string
A text that can show addition information about the link that will be displayed as a tooltip.

Returns string
Remark
Excel has an undocumented tooltip length limit of 255 characters.

Implementation of IHyperlink.tooltip

Methods

isEmpty

isEmpty(): boolean
Returns boolean
Implementation of IHyperlink.isEmpty

toJSON

toJSON(): Partial<{
    address: string;
    history?: string | Partial<boolean>;
    tgtFrame?: string;
    tooltip?: string;
}>
Returns Partial<{
    address: string;
    history?: string | Partial<boolean>;
    tgtFrame?: string;
    tooltip?: string;
}>
Implementation of IHyperlink.toJSON