system.file.saveFile
This function is used in Python Scripting.
Description​
Prompts the user to save a new file named filename. The optional extension and typeDesc arguments can be added to be used as a type filter. If the user accepts the save, the path to that file will be returned. If the user cancels the save, None will be returned.
Client Permission Restrictions​
This scripting function has no Client Permission restrictions.
Syntax #1​
system.file.saveFile(filename)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | filename | A file name to suggest to the user. |
Returns​
String - The path to the file that the user decided to save to, or None if they canceled.
Scope​
Client
Syntax #2​
system.file.saveFile(filename , extension , typeDesc)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | filename | A file name to suggest to the user. |
| String | extension | The appropriate file extension, like "jpeg", for the file. |
| String | typeDesc | A description of the extension, like "JPEG Image". |
Returns​
String - The path to the file that the user decided to save to, or None if they canceled.
Scope​
Client
Code Examples​
Example #1
# 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 is not None:
system.file.writeFile(path, event.source.parent.getComponent("Text Area").text)