Interface DocumentLink

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.

interface DocumentLink {
    data?: any;
    range: Range;
    target?: string;
    tooltip?: string;
}

Properties

data? range target? tooltip?

Properties

Optionaldata

data?: any

A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.

range

range: Range

The range this link applies to.

Optionaltarget

target?: string

The uri this link points to. If missing a resolve request is sent later.

Optionaltooltip

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.

Since

3.15.0

Settings

Member Visibility

On This Page

Properties