Extensions.CommonDialogs.FileOpenDialog
Revision as of 05:28, 13 September 2019 by Hb (talk | contribs) (Created page with "{{DISPLAYTITLE:OTX '''FileOpenDialog'''}}Category:CommonDialogs == Classification == {{ClassificationActivity | FileOpenDialog | Opens a (runtime-specific) file selection...")
Classification
Name | FileOpenDialog |
Short Description | Opens a (runtime-specific) file selection dialog |
Class | Action |
Extension | OTX CommonDialogs extension |
Group | - |
Exceptions | - |
Checker Rules | CommonDialogs_Chk001 |
Standard Compliant | Yes |
OTL Syntax
CommonDialogs.FileOpenDialog(StringTerm message, StringTerm title, StringTerm initialPath, StringTerm extensions, BooleanTerm allowMultiSelect, BooleanTerm checkFileExists, ListVariable result);
Description
The FileOpenDialog activity is used to open a (runtime-specific) file selection dialog. The user can select one or more files and click to accept the selection, or can close the dialog. The dialog can be configured using the optional elements to add a title and modify behavior (such as selection of single or multiple files). 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
| |||
Extensions | String | Term | - | [0..1] | The optional (comma separated) list of extensions to filter in this dialog. | |||
AllowMultiSelect | Boolean | Term | - | [0..1] | The optional flag to determine if the dialog will allow the user to select more than one file. | |||
CheckFileExists | Boolean | Term | - | [0..1] | The optional flag to determine if the dialog must check for the file before allowing the user to complete. | |||
Result | List | Variable | - | [1..1] | The selected file(s), returned as a list of strings.
|
OTL Examples
/// Local Declarations
List<String> List1;
/// Flow
CommonDialogs.FileOpenDialog("This is the Message", "This is the Title", "file:///D:/ReadFile/abc.txt", "txt,zip,pnj", true, true, List1);