Text GetBGColor: Difference between revisions
From MultiCharts
m (→Example) |
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 11: | Line 11: | ||
== Notes == | == Notes == | ||
An object-specific ID number is returned by [[Text_New]] when the text object is created. | * 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 == | == Examples == | ||
Assign an [[RGB]] color number, corresponding to the background color of the text object with an ID number of 3, to Value1 variable: | Assign an [[RGB]] color number, corresponding to the background color of the text object with an ID number of 3, to Value1 variable: | ||
Latest revision as of 12:42, 13 February 2012
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);