Arw SetColor

From MultiCharts
Jump to: navigation, search

Assigns the specified color to the arrow contained in an arrow object with the specified ID number.

Arw_SetColor returns a value of 0 if the color was successfully assigned, and a value of -2 if the specified object ID number is invalid.

Usage

Arw_SetColor(ObjectID, ArrowColor)

Parameters

ObjectID - a numerical expression specifying the object ID number.
ArrowColor - an expression specifying the color of the arrow.
The color can be specified by a numerical expression representing an RGB color number or a legacy color value, or by one of 17 base color words.

Notes

Examples

Assign the color blue to the arrow contained in an arrow object with the ID number of 3:

Value1 = Arw_SetColor(3, Blue);

Assign the RGB color 2138336 (Orange) to the arrow contained in an arrow object with the ID number of 3:

Value1 = Arw_SetColor(3, 2138336);

Assign the legacy color 4 (Green) to the arrow contained in an arrow object with the ID number of 3:

[LegacyColorValue = True];
 
Value1=Arw_SetColor(3, 4);