View source

typedef OpenDialogOptions

package vscode

Options to configure the behaviour of a file open dialog.

  • Note 1: On Windows and Linux, a file dialog cannot be both a file selector and a folder selector, so if you set both canSelectFiles and canSelectFolders to true on these platforms, a folder selector will be shown.
  • Note 2: Explicitly setting canSelectFiles and canSelectFolders to false is futile and the editor then silently adjusts the options to select files.

Fields

@:optionaloptionaltitle:Null<String>

Dialog title.

This parameter might be ignored, as not all operating systems display a title on open dialogs (for example, macOS).

@:optionaloptionalopenLabel:Null<String>

A human-readable string for the open button.

@:optionaloptionalfilters:Null<DynamicAccess<Array<String>>>

A set of file filters that are used by the dialog. Each entry is a human-readable label, like "TypeScript", and an array of extensions, e.g.

{
'Images': ['png', 'jpg']
'TypeScript': ['ts', 'tsx']
}

@:optionaloptionaldefaultUri:Null<Uri>

The resource the dialog shows when opened.

@:optionaloptionalcanSelectMany:Null<Bool>

Allow to select many files or folders.

@:optionaloptionalcanSelectFolders:Null<Bool>

Allow to select folders, defaults to false.

@:optionaloptionalcanSelectFiles:Null<Bool>

Allow to select files, defaults to true.