Core Function FileOpenDialog

From Sputnik Wiki
Jump to: navigation, search
FileOpenDialog ( <title>, <dir>, <filter>, <options>, <default name> )

Contents

Description

Initiates a Load File Dialog.

Parameters

title

Title text of the Dialog GUI.

dir

Initial directory selected in the GUI file tree.

filter

File type filter such as "All|*.*" or "Text files|*.txt"

options

Optional;

[optional] Dialog Options: To use more than one option, use a + sign to separate them (eg: 1 + 4).
  1 = File Must Exist (if user types a filename) -- Default FALSE
  2 = Path Must Exist (if user types a path) -- Default FALSE
  4 = Allow MultiSelect -- Default FALSE
  8 = Automatically adds an extension to a file name if the user omits the extension -- Default FALSE

default name

Optional; File name to suggest to the user to save the file with.

Return Value

Success: Returns all the chosen files as an array.

Failure: Returns null if user cancelled.

Remarks

Separate the file filters with a semicolon as shown in the example.

If default name is given, options must also be given. If none of the options are wanted, use 0 for options.

Special Windows folders (such as "My Documents") can be sometimes be set as the init dir.

Example

$var = FileOpenDialog($message, @WinDir, "Image Files|*.bmp;*.png", 4 + 1 );
 
If (!$var)
{
    MsgBox("No File(s) chosen");
}
Else
{
    foreach($var as $i)
    {
        println("Item '$i'");
    }
    $var = Join($var, @CRLF);
    MsgBox("You chose $var");
}
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox