Developer Resources

ProjectFileDialog

Overview

Class that represents a project file dialog.

Constructor

ProjectFileDialog(mode : Integer)

Arguments

mode
The mode specifies what type of ProjectFileDialog will be created and is one of ProjectFileDialog.OpenFile, ProjectFileDialog.SaveFile, or ProjectFileDialog.ChooseFolder

Properties

ProjectFileDialog.OpenFile
A flag representing the open project file dialog.
ProjectFileDialog.SaveFile
A flag representing the save project file dialog.
ProjectFileDialog.ChooseFolder
A flag representing the choose project folder dialog.

Methods

ProjectFileDialog.getCaption
Gets the caption of the project file dialog.
ProjectFileDialog.getPath
Gets the path selected by the user.
ProjectFileDialog.setCaption
Sets the caption for the project file dialog.
ProjectFileDialog.setPath
Sets the initial path to show in the project file dialog.
ProjectFileDialog.showDialog
Shows the project file dialog.

ProjectFileDialog.getCaption

function ProjectFileDialog.getCaption() : String

Returns

Returns the caption of the project file dialog.

Description

Returns the caption of the project file dialog.

ProjectFileDialog.getPath

function ProjectFileDialog.getPath() : String

Returns

Returns the path selected by the user.

Description

Returns the path selected by the user.

ProjectFileDialog.setCaption

function ProjectFileDialog.setCaption(text : String)

Arguments

text
The text to which to set the caption of the project file dialog.

Description

Sets the caption of the project file dialog to text.

ProjectFileDialog.setPath

function ProjectFileDialog.setPath(text : String)

Arguments

text
The initial path to show in the project file dialog.

Description

Sets the initial path to show in the project file dialog.

ProjectFileDialog.showDialog

function ProjectFileDialog.showDialog() : Boolean

Returns

Returns DialogResult.Ok when the dialog is closed by pressing "OK" or equivalent, and DialogResult.Cancel if the dialog is closed by pressing "Cancel" or equivalent.

Description

Shows a project file dialog and returns DialogResult.Ok if the user closes the project file dialog by pressing "OK", or the equivalent, and DialogResult.Cancel if the user closes the project file dialog by pressing "Cancel", or the equivalent.