Class IDialogs

Interface for file and message dialogs.

Hierarchy (View Summary)

ScriptObject
- IDialogs

Index

Constructors

Methods

getTypeName isOfType isSame selectFilesToOpen selectFileToOpen selectFileToSave selectFolderToOpen selectFolderToSave

Constructors

`Protected`constructor

new IDialogs(): IDialogs
Snap Hidden
Returns IDialogs
Overrides ScriptObject.constructor

Methods

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from ScriptObject.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from ScriptObject.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from ScriptObject.isSame

selectFilesToOpen

selectFilesToOpen(params: Params, defaultPath: Path): Path[]
Open a file selection dialog allowing multiple selections and return an array of selected file paths.
Parameters
- params: Params
- defaultPath: Path
Returns Path[]

selectFileToOpen

selectFileToOpen(params: Params, defaultPath: Path): Path
Open a file selection dialog and return the selected file path.
Parameters
- params: Params
- defaultPath: Path
Returns Path

selectFileToSave

selectFileToSave(params: Params, defaultPath: Path): Path
Open a file save dialog and return the selected file path.
Parameters
- params: Params
- defaultPath: Path
Returns Path

selectFolderToOpen

selectFolderToOpen(params: Params, defaultPath: Path): Path
Returns selected path, or an empty path if the dialog was cancelled.
Parameters
- params: Params
- defaultPath: Path
Returns Path

selectFolderToSave

selectFolderToSave(params: Params, defaultPath: Path): Path
Open a folder selection dialog for saving and return the selected folder path.
Parameters
- params: Params
- defaultPath: Path
Returns Path