Script Editor
The Script Editor, shown below, allows you to add, delete, and modify scripts.
You can access the Script Editor from HEC-DSSVue's Tools menu by clicking Script Editor. Components of the Script Editor include the Menu Bar, the Editor Panel, and the Tree Hierarchy. The following sections describe these components.
File Menu Commands
New | Creates a new script stored at the currently selected position. Available only when a folder node is the selected node in the scripts tree. |
Open | Edits the currently displayed script. Double clicking on the script also edits the currently displayed script. Available only when a script node is the selected node in the scripts tree. |
Import | Imports a file into the script browser. If the import is successful the browser is placed in edit mode. Available only when a folder node is the selected node in the scripts tree. |
Save | Saves the current script. Available only when a script is being edited. |
Save As | Saves the current script, allowing the user to change the label. Note that the name of the script file does not change. Available only when a script is being edited. |
Delete | Deletes the currently opened script. Prompts user for confirmation. Available only when a script node is the selected node in the scripts tree. |
Test | Executes the currently selected script. |
Close | Closes the Script Editor. |
Edit Menu Commands
Cut Script | Cuts the script at the currently selected tree node to the system clipboard. Available only when a script node is selected in the tree view. |
Copy Script | Copies the script at the currently selected tree node to the system clipboard. Available only when a script node is selected in the tree view. |
Paste Script | Pastes the script in the system clipboard to the currently selected tree node. Available only when a folder node is selected in the tree view. |
Option Menu Commands
Set Font | Opens a dialog box that allows setting of the font used in the script text area. Fixed-space fonts such as "Courier New" and "Lucida Console" are recommended over proportional fonts. |
Set Tab Size | Opens a dialog box that allows setting the number of spaces that will be displayed in the script text area for each tab character. |
Editor Panel
You can select and edit scripts in the Editor Panel , shown below, of the Script Editor.
Editor Panel
The Label field allows you to specify the label displayed on a script's button in the Script Selector.
Script displays the name of the file in which the script is stored.
Selecting Show in Scripts Menu causes the script todisplay in the Scripts menu.
Selecting Show in Script Selector causes the script to be displayed on the Script Selector.
Selecting Display Script on Toolbar causes the script to be displayed on the Toolbar.
The Icon field allows you to choose the Icon to display for the script's button. If you do not select an icon, the script name displays in the script's button.
The Description field allows you to add a description of the script. The first line of your description serves as a tooltip for the corresponding button on the Script Selector and Toolbar.
The Script Text field contains the script text itself and serves as an editing window for creating new scripts.
The script text field has a context menu that can be accessed by right-clicking in the script text field.
Script Text Field Context Menu Commands
Cut | Copies the currently-selected script text to the system clipboard and removes it from the script. |
Copy | Copies the currently-selected script text to the system clipboard and leaves it in the current script. |
Paste | Copies text in the system clipboard into the script at the current cursor location. |
Select All | Selects all the text in the script. |
Find | Opens a dialog that allows the user to search for specific text in the script. If text is currently selected in the script, the dialog is initialized with this text. |
Find Next | Locates the next text in the script that matches the conditions of the most recently executed find command. |
Find Previous | Locates the previous text in the script that matches the conditions of the most recently executed find command. |
Goto Line | Opens a dialog that allows the user to cause the cursor to jump to the beginning of a specified line in the script text. |
Tree Hierarchy
The Tree Hierarchy, as shown below, uses a Windows Explorer-style tree structure to allow you to navigate folders in your directory structure and access scripts. Scripts are stored in a "scripts" directory under the windows user %APPDATA% directory. For example C:\Users\RoyBeard\AppData\Roaming\HEC\HEC-DSSVue\scripts
The Tree Hierarchy also has a context menu that displays Cut Script, Copy Script, and Edit Script commands for script nodes and New Script, Import Script, and Paste Script for folder nodes.
These commands cause the same actions as the File and Edit menu commands discussed above. To access the context menu, point to a node in the "tree" and right-click with your mouse.
