View source

class DocumentLink

package vscode

@:jsRequire("vscode","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.

Constructor

new(range:Range, ?target:Uri)

Creates a new document link.

Parameters:

range

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

target

The uri the document link points to.

Variables

range:Range

The range this link applies to.

target:Null<Uri>

The uri this link points to.

tooltip:Null<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.