Text GetBGColor

From MultiCharts
Jump to: navigation, search

Returns an RGB color number or a legacy color value that correspond to the background color of a text object with the specified ID number.

Text_GetBGColor returns a value of -2 if the specified object ID number is invalid.

Usage

Text_GetBGColor(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.
  • Use Text_SetBGColor to set the background color for a text object.

Examples

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

Value1 = Text_GetBGColor(3);

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

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