Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SaveFileDialog

An object representing a dialog to allow the user to save a file.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new SaveFileDialog(initialDirectory: string, filter: string[], callback: (path: string) => void): any

  • Creates a file open dialog.

    Parameters

    • initialDirectory: string

      The initial directory to start in.

    • filter: string[]

      The file filter to use.

    • callback: (path: string) => void

      The callback to call once the dialog completes.

        • (path: string): void

        • Parameters

          • path: string

          Returns void

    Returns any

Properties

completed

completed: false

Whether the operation has completed.

currentPath

currentPath: string

The current path.

dlg

dlg: StandardWindow

Underlying dialog window.

filter

filter: String[]

The file filter to use.

An example is [".png", ".txt"].

fsv

fsv: FSViewUIComponent

FileSystemView component

pathBar

pathBar: HTMLInputElement

Pathbar element

title

title: String

The dialog title.

Methods

_conclude

  • _conclude(): Promise<void>

  • [internal] Concludes the file selection.

    Returns Promise<void>

_createWindow

  • _createWindow(): Promise<void>

  • [internal] Creates the window for this dialog.

    Returns Promise<void>

_navigate

  • _navigate(path: String, quiet?: boolean, addHistory?: boolean): Promise<void>

  • [internal] Navigates the dialog to the specified path.

    Parameters

    • path: String

      The path to navigate to.

    • Optional quiet: boolean

      Whether to be quiet.

    • Optional addHistory: boolean

      Whether to populate history.

    Returns Promise<void>

callback

  • callback(path: string): void

  • On complete callback

    Parameters

    • path: string

    Returns void

show

  • show(): Promise<void>

  • Shows the dialog.

    Returns Promise<void>

Generated using TypeDoc