Navigation: Using Visual Build > Dialogs > Action Properties > Action Properties Dialog GUI Tab |
|
This tab of the Action Properties dialog is used to edit the general GUI tabs of a user action. Fields on the dialog:
Tabs & Properties grid: Configures the tabs and fields displayed in the Step Properties dialog in a step for the action.
Note: Not all columns are shown by default. To show additional columns, right-click the grid header and select a column name. Grid columns can also be resized by dragging the size bar or column header.
Insert Tab: Inserts a new Tab row into the grid (shortcut: Shift+Insert). Each tab row will display as another tab in the Step Properties dialog in a step for the action.
Insert Property: Inserts a new Property row into the grid (shortcut: Insert). Each property row will display a field on the Step Properties dialog. Any values that the user enters in these fields will be assigned to the step's properties and will be accessible from the action's component logic when the step is built. The following columns are available for each property:
Name |
Defines the step property this field's data will be stored in (accessed in the action via Step.ExpProperty). The value is case-sensitive. Standard step properties use all lowercase, so to avoid conflicts with the standard properties, use camel-cased property names (i.e., PropertyXyz) for property names. For Grid fields, the value can either be a single property name for a single column grid or two property names separated by a semi-colon (;) character for a two-column grid for name/value pairs stored in separate step properties. |
Caption |
The caption that will be displayed next to the field on the step properties dialog. If left blank, the property name will be used instead. |
Type |
Defines the type of field to create. Supported types: Edit: an edit control with optional drop-down list Check: checkbox. Combo: a drop-down list combo Grid: a one- or two-column grid for entering an array of values Radio: a set of radio buttons |
Default Value |
Defines the default value to set the field to for new steps that are created (defaults to blank for Edit controls, unchecked for Check fields, the first item for Combo and Radio fields if not provided); the value should be a string value for Edit controls, 0 for unchecked/non-zero for checked Combos, and a 0-based index for Combo and Radio controls. |
Required |
Indicates whether the user will be required to enter a value for the field (applies only to Edit fields). |
Password |
Applies to Edit fields only; if checked, indicates that the value entered should be protected, displaying dots instead of the actual characters typed. |
Filter |
Specifies a filter to use when showing the Browse dialog in the Step Properties dialog. Separate the name and mask extensions and each mask with a vertical bar (|), and separate each mask with a semicolon (;). For example: Text files (*.txt, *.csv)|*.txt;*.csv|Excel files (*.xls)|*.xls |
Folder Browse |
If checked, the Step Properties dialog Browse button will display a folder browse dialog instead of a file browse dialog (the Filter field does not apply if this option is checked). |
List Data |
Defines a list of strings to add to a Radio, Combo, or Edit control field; separate list values with a semicolon (;) character. This field is required for Combos and Radio fields. |
Width |
Specifies a non-default width in dialog units for the control (the control is not automatically resized with the dialog if a width is specified). |
Height |
Specifies a non-default height in dialog units for the control. |
Delete: Deletes the selected row from the grid (shortcut: Delete).
Move Up: Moves the selected row up in the grid (shortcut: Ctrl+U).
Move Down: Moves the selected row down in the grid (shortcut: Ctrl+D).
Preview: Displays the step properties dialog to show the layout of the GUI tabs and fields.
Other shortcuts
F2 or F4 or typing text: edit the selected cell's value.
Ctrl+C: Copy the selected row to the clipboard.
Ctrl+V: Paste the copied row, creating a new row.