Arw SetTextColor

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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

Arw_SetTextColor 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_SetTextColor(ObjectID, TextColor)

Parameters

ObjectID - a numerical expression specifying the object ID number.

TextColor - an expression specifying the color of the text.

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

An object-specific ID number is assigned by Arw_New, Arw_New_s, Arw_New_self or Arw_New_self_s when the arrow object is created.
Use Arw_GetActive, Arw_GetFirst or Arw_GetNext to get the object-specific ID number of an already created arrow.

Examples

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

Value1 = Arw_SetTextColor(3, Blue);

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

Value1 = Arw_SetTextColor(3, 2138336);

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

[LegacyColorValue = True];

Value1 = Arw_SetTextColor(3, 4);