unhighlight_objects - 2023.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2023-05-16
Version
2023.1 English

Unhighlight objects that are currently highlighted

Syntax

unhighlight_objects [‑color_index <arg>] [‑rgb <args>] [‑color <arg>]
    [‑leaf_cells] [‑quiet] [‑verbose] [<objects>]

Usage

Name Description
[-color_index] Color index
[-rgb] RGB color index list
[-color] Valid values are red green blue magenta yellow cyan and orange
[-leaf_cells] Leaf cells
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<objects>] Objects to unhighlight

Categories

GUIControl

Description

This command is for use in GUI mode. This command unhighlights the specified object or objects that were previously highlighted by the highlight_objects command.

This command supports the color options as specified below. These options can be used to unhighlight all objects currently highlighted in the specified color. See the example below.

Arguments

-color_index <arg> - (Optional) Valid value is an integer from 1 to 20. Specify the color index to unhighlight. The color index is defined by the Colors > Highlight category of the Tools > Settings dialog box. Refer to the Vivado Design Suite User Guide: Using the IDE (UG893) for more information on setting themes.

-rgb <args> - (Optional) Specify the color to unhighlight in the form of an RGB code specified as {R G B}. For instance, {255 255 0} specifies the color yellow.

-color <arg> - (Optional) Specify the color to unhighlight by name. Supported highlight colors are red, green, blue, magenta, yellow, cyan, and orange.

-leaf_cells <arg> - (Optional) Specifies one or more cell names or objects to unhighlight based on the specified color.

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

<objects> - (Optional) Specifies one or more objects to be unhighlighted. If no objects are specified, all highlighted objects of the specified color will be unhighlighted. If no color is specified, all highlighted objects will be unhighlighted.

Examples

The following example unhighlights the specified cell objects:

unhighlight_objects -leaf_cells [get_cells cpuEngine/*]

The following example unhighlights all objects currently highlighted in the color yellow:

unhighlight_objects -color yellow