Options to configure the behaviour of a file open dialog.
canSelectFiles and canSelectFolders to true on these platforms, a folder selector will be shown.canSelectFiles and canSelectFolders to false is futile
and the editor then silently adjusts the options to select files.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.
(can-select-files? open-dialog-options)Allow to select files, defaults to true.
Returns: boolean | undefined
Allow to select files, defaults to `true`. **Returns:** `boolean | undefined`
(can-select-folders? open-dialog-options)Allow to select folders, defaults to false.
Returns: boolean | undefined
Allow to select folders, defaults to `false`. **Returns:** `boolean | undefined`
(can-select-many? open-dialog-options)Allow to select many files or folders.
Returns: boolean | undefined
Allow to select many files or folders. **Returns:** `boolean | undefined`
(default-uri open-dialog-options)The resource the dialog shows when opened.
Returns: Uri | undefined
The resource the dialog shows when opened. **Returns:** `Uri | undefined`
(filters open-dialog-options)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, for example:
{
'Images': ['png', 'jpg'],
'TypeScript': ['ts', 'tsx']
}
Returns: { [name: string]: string[]; } | undefined
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, for example:
```ts
{
'Images': ['png', 'jpg'],
'TypeScript': ['ts', 'tsx']
}
```
**Returns:** `{ [name: string]: string[]; } | undefined`(open-label open-dialog-options)A human-readable string for the open button.
Returns: string | undefined
A human-readable string for the open button. **Returns:** `string | undefined`
(set-can-select-files! open-dialog-options value)Allow to select files, defaults to true.
Allow to select files, defaults to `true`.
(set-can-select-folders! open-dialog-options value)Allow to select folders, defaults to false.
Allow to select folders, defaults to `false`.
(set-can-select-many! open-dialog-options value)Allow to select many files or folders.
Allow to select many files or folders.
(set-default-uri! open-dialog-options value)The resource the dialog shows when opened.
The resource the dialog shows when opened.
(set-filters! open-dialog-options value)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, for example:
{
'Images': ['png', 'jpg'],
'TypeScript': ['ts', 'tsx']
}
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, for example:
```ts
{
'Images': ['png', 'jpg'],
'TypeScript': ['ts', 'tsx']
}
```(set-open-label! open-dialog-options value)A human-readable string for the open button.
A human-readable string for the open button.
(set-title! open-dialog-options value)Dialog title.
This parameter might be ignored, as not all operating systems display a title on open dialogs (for example, macOS).
Dialog title. This parameter might be ignored, as not all operating systems display a title on open dialogs (for example, macOS).
(title open-dialog-options)Dialog title.
This parameter might be ignored, as not all operating systems display a title on open dialogs (for example, macOS).
Returns: string | undefined
Dialog title. This parameter might be ignored, as not all operating systems display a title on open dialogs (for example, macOS). **Returns:** `string | undefined`
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |