system.file.saveFile

Description

Prompts the user to save a new file named filename. The optional extension and typeDesc arguments will be used for a file type filter, if any. If the user accepts the save, the path to that file will be returned. If the user cancels the save, None will be returned.

Syntax

system.file.saveFile(filename [, extension] [, typeDesc])

Parameters

String filename - A file name to suggest to the user.

String extension - The appropriate file extension, like "jpeg", for the file. [optional]

String typeDesc - A description of the extension, like "JPEG Image" [optional]

Returns

String - The path to the file that the user decided to save to, or None if they canceled.

Scope

Client

Examples

This code would prompt the user to save the text in a text area to a file.

path = system.file.saveFile("myfile.txt")
if path != None:
   system.file.writeFile(path, event.source.parent.getComponent("Text Area").text)