Object Model: XSIUIToolkit.PickFolder

XSIUIToolkit.PickFolder

Introduced

v5.1

Description

Launches a browse session to pick a particular folder. The browser opens with the specified folder (DefaultFolder).

The folder that has been picked is returned, or an empty string if the user clicked Cancel on the folder picker dialog.

C# Syntax

String XSIUIToolkit.PickFolder( String in_DefaultFolder, String in_Title );

Scripting Syntax

oString = XSIUIToolkit.PickFolder( DefaultFolder, [Title] );

Return Value

String

Parameters

Parameter	Type	Description
DefaultFolder	String	Default folder to start browsing from
Title	String	Title of the folder browser.

Examples

JScript Example

var defaultpath = Application.InstallationPath( siProjectPath ) + XSIUtils.Slash + "Models";
var folder = XSIUIToolkit.PickFolder( defaultpath, "SDK Example" ) ;
if ( folder.length == 0 ) {
        LogMessage( "Cancelled" ) ;
} else {
        LogMessage( "Folder picked : " + folder ) ;
}