Options
All
  • Public
  • Public/Protected
  • All
Menu

A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.

Hierarchy

  • DocumentLink

Index

Constructors

Properties

Constructors

constructor

  • Creates a new document link.

    Parameters

    • range: Range

      The range the document link applies to. Must not be empty.

    • Optional target: Uri

      The uri the document link points to.

    Returns DocumentLink

Properties

range

range: Range

The range this link applies to.

Optional target

target: Uri

The uri this link points to.

Optional tooltip

tooltip: string

The tooltip text when you hover over this link.

If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as {0} (ctrl + click). The specific instructions vary depending on OS, user settings, and localization.

Generated using TypeDoc