The LoadDirectoryName Plugin is used to load a directory path into a variable by displaying a "Browse for Folder" dialog window for a user to browse the operating system.
Syntax:
PLUGIN LoadDirectoryName VarName|<options>
Options:
Option |
Values |
Description |
TITLE |
value |
Specifies the title caption |
PATH_NAME |
value |
Specifies the starting location |
WINDOW_STATE |
MAX/MIN/NORMAL |
Specifies the window state |
HEIGHT |
value |
Specifies the window height |
WIDTH |
value |
Specifies the window width |
SHOW_BUTTONS |
ON/OFF |
Determines if the "Create Folder" and "Delete" buttons are displayed |
CONTEXT_MENUS |
ON/OFF |
Determines if a menu is displayed when user right clicks |
READ_ONLY |
ON/OFF |
Determines if the folders names can be altered |
INCLUDE_NON_FOLDERS |
ON/OFF |
Determines if only folders will be displayed |
OLE_DRAG |
ON/OFF |
Supports drag and drop |
OLE_DROP |
ON/OFF |
Supports drag and drop |
CREATE_FOLDER_ICON |
ON/OFF |
Determines if the "Create Folder" icon is displayed on the button |
DELETE_FOLDER_ICON |
ON/OFF |
Determines if the "Delete" icon is displayed on the button |
VIRTUAL_FOLDERS |
ON/OFF |
Determines if virtual folders can be seen |
SHOW_HIDDEN |
ON/OFF |
Determines if hidden folders can be seen |
OK_BUTTON_CAPTION |
value |
Specifies the caption for the "OK" button |
CANCEL_BUTTON_CAPTION |
value |
Specifies the caption for the "Cancel" button |
EXPAND_INITIAL_FOLDER |
ON/CASCADE/OFF |
Determines if; the initial folder node is expanded (ON), the initial folder and the sub-folders are expanded (CASCADE), the initial folder is not expanded (OFF, default). |
AUTO_EXPAND |
ON/OFF |
Determines if single click will expand/close a node when clicked. Otherwise double click is used. This option is for clicking on nodes, not the tree structure. |
Where:
VarName is the variable to return the text value of the selected directory
Notes:
•Each option must be separated by pipe "|" character.
•A value of '[Esc]' will be returned if the [Cancel] button or Close Window [x] button of the folder selection dialog is selected.
Example:
PLUGIN LoadDirectoryName vDirName+
|PATH_NAME C:\RBTI\ +
|SHOW_BUTTONS ON+
|CREATE_FOLDER_ICON OFF+
|DELETE_FOLDER_ICON OFF+
|WIDTH 500+
|HEIGHT 400+
|READ_ONLY ON+
|INCLUDE_NON_FOLDERS OFF+
|SHOW_HIDDEN OFF+
|OK_BUTTON_CAPTION 'Load Folder'+
|EXPAND_INITIAL_FOLDER CASCADE+
|AUTO_EXPAND ON
