Substeps tab - Step Type Properties Dialog Box
- Updated2025-07-21
- 2 minute(s) read
Substeps tab - Step Type Properties Dialog Box
Substeps tab
Use the Substeps tab to specify Pre-Step, Post-Step, Edit, and Custom substeps for the step type. Substeps use substep code modules to define standard actions, other than calling the step code module , TestStand performs for all instances of the step type.
The Substeps tab contains the following options:
- Adapter —The adapter for the next substep you insert into the substep list.
- < Substep List > —The substeps for the step type. Substeps of the same category always appear continuously in the list. Use the Move Up and Move Down buttons to reorder substeps within a category. The order of the substeps in the list defines the order in which Pre- and Post-Step Substeps execute and the order in which the menu items for Edit substeps appear in the context menu of individual sequence views in the Sequence File window.
-
Add
—Displays a menu from which you select the category of substep to insert into the substep list. You can select from the following categories of substeps: Pre-Step Substep, Post-Step Substep, Edit Substep, and Custom Substep.
Note With the exception of substeps named OnNewStep, TestStand does not call custom substeps. Use the TestStand API to invoke a custom substep from a code module or user interface. You can create a custom substep named OnNewStep for TestStand to call each time you create a new step of that type. For example, the built-in If step type uses an OnNewStep substep to insert a matching End step.
- Delete —Deletes the selected substep from the substep list.
- Specify Module —Launches the Specify Module dialog box for the selected substep in the substep list.
- Rename —Changes the name of the selected substep.
- Move Up —Moves the selected substep up within the group of substeps of the same category in the substep list.
- Move Down —Moves the selected substep down within the group of substeps of the same category in the substep list.
-
Substep Info
—The controls in this section are only visible when you select an Edit substep from the substep list.
-
Menu Item Name Expression
—The name of the menu item that invokes the Edit substep in the context menu of individual sequence views in the Sequence File window.
Note If you specify a literal string in this control, you must enclose it in double quotation marks. If you want to use a name from a string resource file , you can use the ResStr expression function to retrieve the name from the file.
- Supports Edit as Read-Only —When you enable this option, the Edit substep code module checks the TestStand API Step.EditAsReadOnly property. If the Step.EditAsReadOnly property is True , the dialog box opens in read-only mode. If you do not want to open the dialog box in read-only mode, leave this option disabled so the TestStand Sequence Editor does not call the Edit substep for read-only steps.
-
Menu Item Name Expression
—The name of the menu item that invokes the Edit substep in the context menu of individual sequence views in the Sequence File window.