Adding Custom Menu Commands - 2022.1 English

Vivado Design Suite User Guide: Using the Vivado IDE (UG893)

Document ID
Release Date
2022.1 English

You can use the Customize Commands dialog box (shown in the following figure) to add system or user-defined Tcl commands to the Vivado IDE main menu and toolbar menu. To open the dialog box, select Tools > Custom Commands > Customize Commands. The custom commands are available from the Tools > Custom Commands menu, with each command listed on the submenu.

Note: The Customize Command menu is persistent with the Vivado IDE and is restored each time the tool is launched. Custom commands are specific to each user and are saved to the commands.paini file output by the Vivado IDE. For more information, see Outputs for Environment Configuration.
Tip: You can also use the create_gui_custom_command Tcl command to add custom menu commands. For details, see Adding Custom Menu Commands Using a Tcl Command.
Figure 1. Customize Commands Dialog Box

You can specify the following options:

Custom Commands
Adds new commands to the custom menu. In the popup window, type the command name, and press Enter to add the command to the list of custom commands.
Removes the selected commands from the custom menu.
Move Up
Moves the selected command up in the list.
Move Down
Moves the selected command down in the list.
Edit Custom Command
Specifies the properties for the selected command in the Custom Commands list.
Menu Name
Specifies the name of the custom command.
Specifies the text to display in the status bar when hovering over the menu command.
Defines a keyboard shortcut for the custom command. Click Add to open the Add Shortcut dialog box, and select the new shortcut from the drop-down menu. To delete a shortcut, click Remove.
Run Command
Runs the specified Tcl command or procedure for the custom command.
Source Tcl File
Sources the specified Tcl script file for the custom command rather than running a single Tcl command or procedure.
Toolbar Options
Specifies whether to add a toolbar button icon for the custom command to the main toolbar.
Add to the Toolbar
Enables the toolbar icon. When this check box is disabled, the custom command does not appear on the main toolbar.
Icon File Path
Specifies the file path to the toolbar button icon. Use a PNG, JPG, or GIF file of approximately 20x20 pixels. The Vivado IDE resizes larger images to fit onto the toolbar.