Smart Rename Dialog Box
- Updated2025-07-21
- 4 minute(s) read
Smart Rename Dialog Box
Select Smart Rename in the context menu of the Variables Pane in the Sequence File Window to launch the Smart Rename dialog box.
The Smart Rename dialog box allows you to rename a variable and then update all references to that variable within the variable’s scope.
The Smart Rename feature can find and process multiple types of variable references .
You can choose to simply perform the Smart Rename operation in default mode or you can preview the operation in preview mode. TestStand provides a status message once the operation is complete.
Default Mode
In the default mode, you can specify the new name of the variable and set the search options. TestStand will find and update all the auto-resolved references , in addition to the type of references checked in the Search Options. If any possible references are identified, the dialog switches to the Preview Mode when you click OK and displays all the identified references and allows you to update the unresolved ones. Any references that remain unresolved when the operation is complete will be reported as part of the operation status displayed in the Output Window.
The default mode offers the following search options:
- Variable Root —Displays the fully qualified name of the parent of the variable being renamed. If the variable renamed is an array element, the Variable Root will display the full name of the array.
- Current Name —Displays the current name of the variable.
- New Name —You can enter the new name of the variable in this input window. If the new name entered is invalid, an error provider will be displayed next to this window. Hovering over the provider will list the reason for the error in a tooltip.
- Process Comments —If this option is checked, TestStand will update any comments where the fully qualified variable name is found.
- Process String Literals —If this option is checked, TestStand will update any string literals where the fully qualified variable name is found. String literals can be literal string values used in TestStand expressions or it could be the value of a String variable.
- Preview —Clicking on this button or using the <Ctrl+P> keyboard shortcut will display a preview of the Smart Rename operation.
- OK —Clicking on this button will commit all the changes and complete the Smart Rename operation.
- Cancel —Clicking on this button will cancel any changes made during this operation.
Preview Mode
You can preview the changes that will occur during the Smart Rename operation in the preview mode. Click the Preview button or use the <Ctrl+P> keyboard shortcut to switch the Smart Rename dialog box into preview mode.
The preview mode displays information in the following areas:
- References —Lists all the references identified for the variable. The variables are grouped based on reference type . The name of each item in this list specifies the location of that reference(s) in the sequence file. Each item can contain multiple references to the variable and the same location can appear under multiple groups. You can click on an item and the value expression for that location will be displayed in the New Expression window. When you accept the changes in the dialog, every item that is checked in this list will be updated and every item that is unchecked will retain its original value.
- New Expression —Displays the value of the location corresponding to the item selected in the References view. If the corresponding item is checked in the References view, this window will be editable and you can update the value as required. Once the value is modified, clicking the Refresh button, pressing <F5>, or navigating away from the New Expression window will update the value of that location to the modified value and refresh the preview based on the new value.
Clicking the Refresh button or pressing <F5> will refresh the preview. You may need to refresh the preview after modifying the name in the New Name window or updating the value displayed in the New Expression window.
Operation Status
TestStand will update the output window with the status of the operation once it is complete. The status messages contain the following information:
- The number of references that were updated.
- The number of references that could not be updated, either because they were possible references that needed user input or because you unchecked a reference item in the preview mode.
- For each reference that could not be updated, an output message will indicate its location. Double-clicking on this message in the output window will take you to the actual location of the reference in Sequence Editor and highlight it.