SheetXL - v0.3.20
    Preparing search index...

    Interface IHyperlink

    Represents a hyperlink for linking to either a URL or a cell address.

    interface IHyperlink {
        isIHyperlink: true;
        getAddress(): string;
        getDisplayText(): string;
        getTarget(): string;
        getTooltip(): string;
        open(target?: "_self" | "_blank", features?: string): Promise<boolean>;
    }
    Index

    Properties

    isIHyperlink: true

    For runtime type checking.

    Methods

    • This can be a url or a cell address.

      Returns string

      A sheet address needs to start with a #.

    • This is either the address or the cell value.

      Returns string

    • Specified the target frame when opening this Hyperlink.

      Returns string

      newWindow

    • Tet for showing addition information about the link that will be displayed as a tooltip.

      Returns string

      Excel has an undocumented tooltip length limit of 255 characters.

    • Open the hyperlink.

      Parameters

      • Optionaltarget: "_self" | "_blank"

        Specifies where to open the linked document. DefaultValue getTarget().

      • Optionalfeatures: string

        Passed to the window open context for external resource.

      Returns Promise<boolean>