Arw GetTextBGColor

From MultiCharts
Revision as of 12:28, 17 January 2012 by 194.84.116.138 (talk) (Created page with "Returns an RGB color number or a legacy color value that correspond to the text background color of an arrow object with the specified ID number; returns a value of -2 if the ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Returns an RGB color number or a legacy color value that correspond to the text background color of an arrow object with the specified ID number; returns a value of -2 if the specified object ID number is invalid.

Usage

Arw_GetTextBGColor(ObjectID)

Where: ObjectID - a numerical expression specifying the object ID number

Notes

An object-specific ID number is returned by

Arw_New

when the arrow object is created.

Example

Assign an RGB color number, corresponding to the text background color of an arrow object with the ID number of 3, to Value1 variable:

Value1=Arw_GetTextBGColor(3);

Assign a legacy color value, corresponding to the text background color of an arrow object with the ID number of 3, to Value1 variable:

[LegacyColorValue=True];
Value1=Arw_GetTextBGColor(3);