Text GetColor

From MultiCharts
Revision as of 13:15, 25 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 color of the text contained in a text object with the specified ID number; returns a value of -2 if ...")
(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 color of the text contained in a text object with the specified ID number; returns a value of -2 if the specified object ID number is invalid.

Usage

Text_GetColor(ObjectID)

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

Notes

An object-specific ID number is returned by Text_New when the text object is created.

Example

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

Value1=Text_GetColor(3);

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

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