FileDialog

This object represents a window allowing the user to choose a file.

Constructor function.

var myObject = new FileDialog();

var myObject = new FileDialog(parameters);

1. parameters - (object) window parameters
   • title - (string) the window's title
   • position - (Point) the window's position
   • opacity - (float) the window's opacity
   • enabled - (boolean) the window's enabled status
   • visible - (boolean) the window's visible status
   • acceptMode - (AcceptMode) the file accept mode
   • fileMode - (FileMode) the file mode
   • viewMode - (ViewMode) the view mode
   • selectedFile - (string) the default selected file
   • selectedNameFilter - (string) the default selected name filter
   • defaultSuffix - (string) the default file suffix
   • directory - (string) the default directory
   • filter - (Filter) the filter
   • nameFilter - (string) the name filter
   • nameFilters - (array) an array of name filters to use
   • showDirectoriesOnly - (boolean) show directories only
   • dontResolveSymlinks - (boolean) do not resolve symbolic links (Linux only)
   • dontConfirmOverwrite - (boolean) do not confirm overwrite
   • dontUseNativeDialog - (boolean) do not use the native dialog
   • readOnly - (boolean) show read-only files (Windows only)
   • hideNameFilterDetails - (boolean) hide the name filter details
   • sidebarUrls - (array) an array of urls shown on the side bar
   • onClosed - (OnClosed event called when the window is closed
   • onCurrentChanged - (OnCurrentChanged event called when the current selection changed
   • onDirectoryEntered - (OnDirectoryEntered event called when the current directory changed
   • onFileSelected - (OnFileSelected event called when the window is closed
   • onFileSelected - (OnFilesSelected event called when the window is closed
   • onFilterSelected - (OnFilterSelected event called when a filter is selected

• (ParameterTypeError) incorrect parameter type
• (ParameterCountError) incorrect parameter count

var myObject = new FileDialog();

var myObject = new FileDialog({
	title: "Select a file",
	acceptMode: FileDialog.Open
});

Sets the window's title.

myObject.setTitle(title);

1. title - (string) the window's title

• (FileDialog) this FileDialog

Sets the window's position.

myObject.setPosition(point);

1. point - (Point) the window's position

• (FileDialog) this FileDialog

Sets the window's opacity.

myObject.setOpacity(opacity);

1. opacity - (float) the window's opacity

• (FileDialog) this FileDialog

Sets the window's enabled status.

myObject.setEnabled(enabled);

1. enabled - (boolean) the window's enabled status

• (FileDialog) this FileDialog

Sets the window's visible status.

myObject.setVisible(visible);

1. visible - (boolean) the window's visible status

• (FileDialog) this FileDialog

Closes the window.

myObject.close();

• (FileDialog) this FileDialog

Returns the window's title.

myObject.title();

• (string) the window's title

Returns the window's position.

myObject.position();

• (Point) the window's position

Returns the window's opacity.

myObject.opacity();

• (float) the window's opacity

Returns the window's enabled status.

myObject.enabled();

• (boolean) the window's enabled status

Returns the window's visible status.

myObject.visible();

• (boolean) the window's visible status

Sets the accept mode.

myObject.setAcceptMode(acceptMode);

1. acceptMode - (AcceptMode) the accept mode

• (FileDialog) this FileDialog

Sets the file mode.

myObject.setFileMode(fileMode);

1. fileMode - (FileMode) the file mode

• (FileDialog) this FileDialog

Sets the view mode.

myObject.setViewMode(viewMode);

1. viewMode - (ViewMode) the view mode

• (FileDialog) this FileDialog

Sets a label text.

myObject.setLabelText(dialogLabel, text);

1. dialogLabel - (DialogLabel) the dialog label
2. text - (string) the label text

• (FileDialog) this FileDialog

Selects a file.

myObject.selectFile(filename);

1. filename - (string) the file to select

• (FileDialog) this FileDialog

Selects the name filter.

myObject.selectNameFilter(filter);

1. filter - (string) the name filter

• (FileDialog) this FileDialog

Selects the default suffix.

myObject.setDefaultSuffix(defaultSuffix);

1. defaultSuffix - (string) the default suffix

• (FileDialog) this FileDialog

Selects the current directory.

myObject.setDirectory(directory);

1. directory - (string) the current directory

• (FileDialog) this FileDialog

Sets the filters.

myObject.setFilter(filters);

1. filters - (Filters) the filters to use

• (FileDialog) this FileDialog

Sets the name filter.

myObject.setNameFilter(nameFilter);

1. nameFilter - (string) the name filter

• (FileDialog) this FileDialog

Sets the name filters.

myObject.setNameFilters(nameFilters);

1. nameFilters - (array) an array of name filters to use

• (FileDialog) this FileDialog

Should the window show directories.

myObject.setShowDirectoriesOnly(showDirectoriesOnly);

1. showDirectoriesOnly - (boolean) show directories only

• (FileDialog) this FileDialog

Should the window resolve symbolic links.

myObject.setDontResolveSymlinks(dontResolveSymlinks);

1. dontResolveSymlinks - (boolean) resolve symbolic links

• (FileDialog) this FileDialog

Should the window ask for confirmation when overwriting a file.

myObject.setDontConfirmOverwrite(dontConfirmOverwrite);

1. dontConfirmOverwrite - (boolean) ask for confirmation when overwriting a file

• (FileDialog) this FileDialog

Should the window use native a dialog.

myObject.setDontUseNativeDialog(dontUseNativeDialog);

1. dontUseNativeDialog - (boolean) use native a dialog

• (FileDialog) this FileDialog

Should the window show readonly files.

myObject.setReadOnly(readOnly);

1. readOnly - (boolean) show readonly files

• (FileDialog) this FileDialog

Hide name filter details.

myObject.setHideNameFilterDetails(hideNameFilterDetails);

1. hideNameFilterDetails - (boolean) hide name filter details

• (FileDialog) this FileDialog

Sets the sidebar urls.

myObject.setSidebarUrls(sidebarUrls);

1. sidebarUrls - (array) the sidebar urls

• (FileDialog) this FileDialog

Returns the selected file.

myObject.selectedFile();

• (string) the selected file

Returns the selected files.

myObject.selectedFiles();

• (array) the selected files

Returns the name filter.

myObject.selectedNameFilter();

• (string) the selected name filter

Returns the name filter.

myObject.selectedNameFilter();

• (string) the selected name filter

Show the window. (non-blocking) Use the OnClosed event to know when the window has been closed.

myObject.show();

• (FileDialog) this FileDialog

Show the window. (blocking)

myObject.showModal();

• (integer) the window result (0 means that it has been canceled)

Called when the window is closed.

myObject.onClosed = function(result) {};

1. result - (integer) the window result (0 means that it has been canceled)

myObject.onClosed = function(result)
{
	if(result)
	{
		//Event action
	}
};

Called when the current file has changed.

myObject.onCurrentChanged = function(path) {};

1. path - (string) the current file

myObject.onCurrentChanged = function(path)
{
	//Event action
};

Called when the current directory has changed.

myObject.onDirectoryEntered = function(directory) {};

1. directory - (string) the current file

myObject.onDirectoryEntered = function(directory)
{
	//Event action
};

Called when the dialog is accepted.

myObject.onFileSelected = function(file) {};

1. file - (string) the selected file

myObject.onFileSelected = function(file)
{
	//Event action
};

Called when the dialog is accepted.

myObject.onFilesSelected = function(files) {};

1. files - (array) the selected files, as an array containing filenames

myObject.onFilesSelected = function(files)
{
	//Event action
};

Called when the filter is changed.

myObject.onFilterSelected = function(filter) {};

1. filter - (string) the new filter

myObject.onFilterSelected = function(filter)
{
	//Event action
};

The window's title. (string)

The window's position. (Point)

The window's opacity. (float)

The window's enabled status. (boolean)

The window's visible status. (boolean)

Sets the accept mode of the window.

1. Open: the dialog is used to open a file
2. Save: the dialog is used to save to a file

Sets the file mode of the window.

1. AnyFile: the selected file has not to exist to be selected
2. ExistingFile: there is only one file that can be selected and it has to exist
3. ExistingFiles: zero or more existing file can be selected
4. Directory: a directory can be selected

Sets the view mode of the window.

1. Detail: show files with details
2. List: show only the file name and icon

The label of the window to edit.

1. LookIn: the "look in" label
2. FileName: the filename label
3. FileType: the filetype label
4. Accept: the accept label
5. Reject: the reject label

The filters to use.

1. Dirs: list directories
2. AllDirs: list all directories without applying filters to directory names
3. Files: list files
4. Drives: list drives (Windows only)
5. NoSymLinks: do not list symbolic links (Linux only)
6. NoDotAndDotDot: do not list the special entries . and ..
7. NoDot: do not list the special entry .
8. NoDotDot: do not list the special entry ..
9. AllEntries: list directories, files and drives (same as Dirs | Files | Drives)
10. Readable: list readable files
11. Writable: list writable files
12. Executable: list executable files
13. Modified: list modified files (Windows only)
14. Hidden: list hidden files (on Linux, files starting with a dot)
15. System: list system files
16. CaseSensitive: the filter string should be case sensitive

This is a flag enumeration, this means that you can use multiple values using the | operator. Example :

myObject.setFilter(FileDialog.Files | FileDialog.Executable); //List only files that are executable