pltILegend SetColor

Sets the legend border to the specified color.

Syntax

pltILegend_handle SetColor color

Application

Tcl Modify

Description

Color values range from 0-63, with 0 corresponding to black.

Returns 0 if successful; error code (see below) if unsuccessful.

Inputs

color
Integer value corresponding to the desired color of the legend border.

Example

To set the color of the legend border to cyan:
hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProjectName
myProjectName GetPageHandle myPageName 1
myPageName GetWindowHandle myWindow 1
myWindow GetClientHandle myClient
myClient GetLegendHandle myLegend
myLegend SetColor 6

Errors

3 = HW_InvalidHandle ("Handle is no longer valid") if the handle is invalid.

4 = HW_InvalidArgs ("Invalid command args <arguments>") if the number is less than 0 or greater than 63.