Text SetBGColor: Difference between revisions
From MultiCharts
No edit summary |
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 14: | Line 14: | ||
== 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_GetBGColor]] to get the background color for a specific text object. | |||
== Example == | == Example == | ||
Assign the color blue to the background of a text object with the ID number of 3: | Assign the color blue to the background of a text object with the ID number of 3: | ||
Latest revision as of 12:39, 13 February 2012
Assigns the specified background color to a text object with the specified ID number.
Text_SetBGColor returns a value of 0 if the color was successfully assigned and a value of -2 if the specified object ID number is invalid.
Usage
Text_SetBGColor(ObjectID, BGColor)Parameters
- ObjectID - a numerical expression specifying the object ID number.
- BGColor - an expression specifying the background color.
- The color can be specified by a numerical expression representing an RGB color number or a legacy color value, or by one of 17 base color words.
Notes
- An object-specific ID number is returned by Text_New when the text object is created.
- Use Text_GetBGColor to get the background color for a specific text object.
Example
Assign the color blue to the background of a text object with the ID number of 3:
Value1 = Text_SetBGColor(3, Blue);Assign the RGB color 2138336 (Orange) to the background of a text object with the ID number of 3:
Value1 = Text_SetBGColor(3, 2138336);Assign the legacy color 4 (Green) to the background of a text object with the ID number of 3:
[LegacyColorValue = True];
Value1 = Text_SetBGColor(3, 4);