Arw SetTextBGColor

From MultiCharts
Revision as of 12:42, 13 February 2012 by Admin (talk | contribs) (Reverted edits by 176.8.90.7 (talk) to last revision by 194.84.116.138)
Jump to navigation Jump to search

Assigns the specified background color to the text of an arrow object with the specified ID number; 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_SetTextBGColor(ObjectID,TextBGColor)

Parameters

ObjectID - a numerical expression specifying the object ID number

TextBGColor - an expression specifying the text background color

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 returned by Arw_New when the arrow object is created.

Example

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

Value1=Arw_SetTextBGColor(3,Blue);

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

Value1=Arw_SetTextBGColor(3,2138336);

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

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