Interface IHyperlink

interface IHyperlink {
    address: string;
    history?: boolean;
    tgtFrame?: string;
    tooltip?: string;
    isEmpty(): boolean;
    toJSON(): Partial<{
        address: string;
        history?: string | Partial<boolean>;
        tgtFrame?: string;
        tooltip?: string;
    }>;
}

Hierarchy

Implemented by

Properties

address history? tgtFrame? tooltip?

Methods

isEmpty toJSON

Properties

Readonly address

address: string

This can be a url or a cell address. Note - sheet address need to start with a #

Optional Readonly history

history?: boolean

Specifies whether to add this URI to the history when navigating to it.

Default Value

true

Optional Readonly tgtFrame

tgtFrame?: string

Specified the target frame when opening this Hyperlink.

Default Value

newWindow

Optional Readonly tooltip

tooltip?: string

A text that can show addition information about the link that will be displayed as a tooltip.

Remark

Excel has an undocumented tooltip length limit of 255 characters.

Methods

isEmpty

  • isEmpty(): boolean

  • Returns boolean

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;
    }>

Settings

Member Visibility

Theme

On This Page

addresshistorytgtFrametooltipisEmptytoJSON