Difference between revisions of "Text SetColor"
Jump to navigation
Jump to search
m (→Parameters) |
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_GetColor]] to get the color of a specific text object. | |
| + | |||
== Examples == | == Examples == | ||
Assign the color blue to the text of a text object with the ID number of 3: | Assign the color blue to the text of a text object with the ID number of 3: | ||
Latest revision as of 12:42, 13 February 2012
Assigns the specified color to the text of a text object with the specified ID number.
Text_SetColor returns a value of 0 if the color was successfully assigned, and a value of -2 if the specified object ID number is invalid.
Contents
Usage
Text_SetColor(ObjectID, TextColor)
Parameters
- ObjectID - a numerical expression specifying the object ID number.
- TextColor - an expression specifying the text 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_GetColor to get the color of a specific text object.
Examples
Assign the color blue to the text of a text object with the ID number of 3:
Value1 = Text_SetColor(3 ,Blue);
Assign the RGB color 2138336 (Orange) to the text of a text object with the ID number of 3:
Value1 = Text_SetColor(3, 2138336);
Assign the legacy color 4 (Green) to the text of a text object with the ID number of 3:
[LegacyColorValue = True];
Value1 = Text_SetColor(3, 4);
