system.file.openFile
This function is used in Python Scripting.
Description
Shows an "Open File" dialog box, prompting the user to choose a file to open. Returns the path to the file that the user chose, or None if the user canceled the dialog box. An extension can optionally be passed in that sets the filetype filter to that extension.
Client Permission Restrictions
This scripting function has no Client Permission restrictions.
Syntax
system.file.openFile([extension], [defaultLocation])
Parameters
Type | Parameter | Description |
---|---|---|
String | extension | A file extension, like "pdf", to try to open. [optional] |
String | defaultLocation | A folder location, like "C:\MyFiles", to use as the starting location for the file chooser. [optional] |
Returns
String - The path to the selected file, or None if canceled.
Scope
Client
Code Examples
Example #1
# This code would prompt the user to open a file of type 'gif'. If None is returned, it means the user canceled the open dialog box.
path = system.file.openFile('gif')
if path != None:
# do something with the file
Example #2
# This code would prompt the user to open a file of type 'pdf' from their stored documents folder. If None is returned, it means the user canceled the open dialog box.
# Note: the computer running this code needs to have network access to the "fileserver" computer.
path = system.file.openFile('pdf', '\\fileserver\PDF_Storage')
if path != None:
# do something with the file