plt3DILegend GetHighlighted

Gets whether the legend is highlighted.

Syntax

plt3DILegend_handle GetHighlighted

Application

HyperWorks Tcl Query

Description

The appearance of a highlighted legend will change to indicate that it is active or has been picked through the GUI. To see this effect, alter the highlighted flag to cause a redraw of the client.

Returns true or false.

Example

To check if the legend is highlighted:

hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProjectName
myProjectName GetPageHandle myPageName 1
myPageName GetWindowHandle myWinName 1
myWinName GetClientHandle myClientName
myClientName GetLegendHandle myLegendName
myLegendName GetHighlighted

Errors

None.