Options (fable-electron-docs-api)

Options Type

Namespace: Fable.Electron
Assembly: Fable.Electron.dll
Parent Module: ShowSaveDialogSync
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`Options(?title, ?defaultPath, ?buttonLabel, ?filters, ?message, ?nameFieldLabel, ?showsTagField, ?properties, ?securityScopedBookmarks)` Full Usage: `Options(?title, ?defaultPath, ?buttonLabel, ?filters, ?message, ?nameFieldLabel, ?showsTagField, ?properties, ?securityScopedBookmarks)` Parameters: ?title : `string` - The dialog title. Cannot be displayed on some _Linux_ desktop environments. ?defaultPath : `string` - Absolute directory path, absolute file path, or file name to use by default. ?buttonLabel : `string` - Custom label for the confirmation button, when left empty the default label will be used. ?filters : `FileFilter[]` - ?message : `string` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| Message to display above text fields. ?nameFieldLabel : `string` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| Custom label for the text displayed in front of the filename text field. ?showsTagField : `bool` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| Show the tags input box, defaults to `true`. ?properties : `Properties[]` - ?securityScopedBookmarks : `bool` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ✔ \|\| Create a security scoped bookmark when packaged for the Mac App Store. If this option is enabled and the file doesn't already exist a blank file will be created at the chosen path. Returns: `Options`	?title : `string` The dialog title. Cannot be displayed on some _Linux_ desktop environments. ?defaultPath : `string` Absolute directory path, absolute file path, or file name to use by default. ?buttonLabel : `string` Custom label for the confirmation button, when left empty the default label will be used. ?filters : `FileFilter[]` ?message : `string` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| Message to display above text fields. ?nameFieldLabel : `string` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| Custom label for the text displayed in front of the filename text field. ?showsTagField : `bool` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| Show the tags input box, defaults to `true`. ?properties : `Properties[]` ?securityScopedBookmarks : `bool` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ✔ \|\| Create a security scoped bookmark when packaged for the Mac App Store. If this option is enabled and the file doesn't already exist a blank file will be created at the chosen path. Returns: `Options`


                
                  
                    
                      Options(?title, ?defaultPath, ?buttonLabel, ?filters, ?message, ?nameFieldLabel, ?showsTagField, ?properties, ?securityScopedBookmarks)

Full Usage:

Options(?title, ?defaultPath, ?buttonLabel, ?filters, ?message, ?nameFieldLabel, ?showsTagField, ?properties, ?securityScopedBookmarks)

Parameters:

?title : string - The dialog title. Cannot be displayed on some _Linux_ desktop environments.

?defaultPath : string - Absolute directory path, absolute file path, or file name to use by default.

?buttonLabel : string - Custom label for the confirmation button, when left empty the default label will be used.

?filters : FileFilter[] -

?message : string - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Message to display above text fields.

?nameFieldLabel : string - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Custom label for the text displayed in front of the filename text field.

?showsTagField : bool - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Show the tags input box, defaults to true.

?properties : Properties[] -

?securityScopedBookmarks : bool - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ✔ || Create a security scoped bookmark when packaged for the Mac App Store. If this option is enabled and the file doesn't already exist a blank file will be created at the chosen path.

Returns: Options

?title : string: The dialog title. Cannot be displayed on some _Linux_ desktop environments.
?defaultPath : string: Absolute directory path, absolute file path, or file name to use by default.
?buttonLabel : string: Custom label for the confirmation button, when left empty the default label will be used.
?filters : FileFilter[]
?message : string: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Message to display above text fields.
?nameFieldLabel : string: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Custom label for the text displayed in front of the filename text field.
?showsTagField : bool: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Show the tags input box, defaults to true.
?properties : Properties[]
?securityScopedBookmarks : bool: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ✔ || Create a security scoped bookmark when packaged for the Mac App Store. If this option is enabled and the file doesn't already exist a blank file will be created at the chosen path.

Returns: Options

Instance members

Instance member	Description
`this.buttonLabel` Full Usage: `this.buttonLabel`	Custom label for the confirmation button, when left empty the default label will be used.
`this.defaultPath` Full Usage: `this.defaultPath`	Absolute directory path, absolute file path, or file name to use by default.
`this.filters` Full Usage: `this.filters`
`this.message` Full Usage: `this.message`	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ Message to display above text fields.
`this.nameFieldLabel` Full Usage: `this.nameFieldLabel`	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ Custom label for the text displayed in front of the filename text field.
`this.properties` Full Usage: `this.properties`
`this.securityScopedBookmarks` Full Usage: `this.securityScopedBookmarks`	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ✔ Create a security scoped bookmark when packaged for the Mac App Store. If this option is enabled and the file doesn't already exist a blank file will be created at the chosen path.
`this.showsTagField` Full Usage: `this.showsTagField`	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ Show the tags input box, defaults to true.
`this.title` Full Usage: `this.title`	The dialog title. Cannot be displayed on some Linux desktop environments.