Text GetColor: Difference between revisions
From MultiCharts
(→Usage) |
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
||
| Line 3: | Line 3: | ||
Text_GetColor will return a value of -2 if the specified object ID number is invalid. | Text_GetColor will return a value of -2 if the specified object ID number is invalid. | ||
== Usage == | |||
<syntaxhighlight>Text_GetColor(ObjectID)</syntaxhighlight> | |||
Where: | |||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
== 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. | ||
Latest revision as of 12:42, 13 February 2012
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.
Text_GetColor will return 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.
- Use Text_SetColor to set the color for a text object.
Examples
Assign a 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);