SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface Properties

    Properties available to IHyperlinks.

    interface Properties {
        action?: string;
        address: string;
        history?: boolean;
        screenTip?: string;
        target?: string;
        textToDisplay?: string;
    }
    Index
    action? address history? screenTip? target? textToDisplay?
    action?: string

    An action the link performs instead of, or beside, following its address, as a file states it (hlinkClick/@action). Office's own (ppaction://…) mean nothing in a workbook; kept so the file reads back as written.

    address: string

    Where the link points; a url, a location within this workbook, or both.

    The two destinations are folded into this single value and separated by a #:

    • https://sheetxl.com/ - a url.
    • #Sheet1!A1 - a location within this workbook. (nothing precedes the #)
    • https://sheetxl.com/#pricing - a url with a fragment.

    Excel keeps the two apart as an address and a document reference; folding them is a deliberate difference and a leading # is the only way to write an internal link.

    A location within this workbook is a string and not a reference. It does not follow the cells it points at when rows or columns are inserted, deleted, or moved. (The cell the link is attached to does move.)

    history?: boolean

    Whether following the link adds it to the browsing history (hlinkClick/@history).

    screenTip?: string

    Text showing additional information about the link that will be displayed as a tooltip.

    Excel has an undocumented screen tip length limit of 255 characters.

    target?: string

    Specifies the target frame to use when opening this hyperlink.

    This has no counterpart in Excel; it is ours and applies to links opened in a browser.

    textToDisplay?: string

    The text shown for the link. This is the text of the cell it is attached to, falling back to getAddress() when the cell has none.

    Settings
    Member Visibility

    On This Page
    Properties