Interface ShowDocumentParams

Params to show a resource in the UI.

Since

3.16.0

interface ShowDocumentParams {
    external?: boolean;
    selection?: Range;
    takeFocus?: boolean;
    uri: string;
}

Properties

external? selection? takeFocus? uri

Properties

Optionalexternal

external?: boolean

Indicates to show the resource in an external program. To show, for example, https://code.visualstudio.com/ in the default WEB browser set external to true.

Optionalselection

selection?: Range

An optional selection range if the document is a text document. Clients might ignore the property if an external program is started or the file is not a text file.

OptionaltakeFocus

takeFocus?: boolean

An optional property to indicate whether the editor showing the document should take focus or not. Clients might ignore this property if an external program is started.

uri

uri: string

The uri to show.

Settings

Member Visibility

On This Page

Properties