Difference between revisions of "Extensions.CommonDialogs.SelectDirectoryDialog"

From emotive
Jump to: navigation, search
(Created page with "{{DISPLAYTITLE:OTX '''SelectDirectoryDialog'''}}Category:CommonDialogs == Classification == {{ClassificationActivity | SelectDirectoryDialog | Opens a (runtime-specific) d...")
 
(No difference)

Latest revision as of 06:04, 13 September 2019

Classification

Name SelectDirectoryDialog
Short Description Opens a (runtime-specific) directory selection dialog
Class Action
Extension OTX CommonDialogs extension
Group -
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

CommonDialogs.SelectDirectoryDialog(StringTerm message, StringTerm title, StringTerm initialPath, StringVariable result);

Description

The SelectDirectoryDialog activity is used to open a (runtime-specific) directory selection dialog. The user can select a directory and click to accept the selection, or can close the dialog. The user can configure parts of the dialog behaviour, such as a title and message.

Properties

Name Data Type Class Default Cardinality Description
Message String Term - [0..1] The message to be displayed in the dialog to aid the user in their selection.
Title String Term - [0..1] The title to be displayed in the dialog.
InitialPath String Term - [0..1] The initial path to select.
Icons Note.png If a directory is specified, and it does not exist, or the user does not have sufficient access rights, the behaviour will be dictated by the runtime system.
Result String Variable - [1..1] The selected directory.
Icons Note.png If no directory is selected, the result will be returned as the empty string "".
Icons Note.png This dialog will not allow the user to select (or enter) a directory that does not exist.

OTL Examples

/// Local Declarations

String String1;

/// Flow

CommonDialogs.SelectDirectoryDialog("This is the Message", "This is the Title", "file:///D:/ReadFile/abc.txt", String1);

See also

FileOpenDialog
FileSaveDialog