ssCore.App.showFolderBrowser

Display the standard Windows Browse For Folders dialog to select a folder.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

title - [Optional] - String to be displayed as the title of the folder browser window.

path - [Optional] - Path to the folder where the browse operation will start. If not specified, the browse operation will start at the Windows default folder. This parameter supports monikers.


Output Parameters:

result - The path to the selected folder or an empty string if no folder was selected.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.App.showFolderBrowser( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.App.showFolderBrowser( paramsObject );


Notes:

You can't select folders with the standard Windows "File Open" or "File Save" dialogs so this command displays the standard "Browse For Folder" dialog which allows you to select a folder.


Examples:

// Make sure the window is visible.
ssCore.Win.show();

var return_obj = ssCore.App.showFolderBrowser({title:"Select a folder", path:"startdir://"});

ssDebug.trace(return_obj.result);