Difference between revisions of "Text GetColor"
Jump to navigation
Jump to search
(Created page with "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; returns a value of -2 if ...") |
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | 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 | + | 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 == | |
<syntaxhighlight>Text_GetColor(ObjectID)</syntaxhighlight> | <syntaxhighlight>Text_GetColor(ObjectID)</syntaxhighlight> | ||
| − | Where: | + | 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. | + | * 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. | |
| − | == | + | |
| − | Assign | + | == Examples == |
| + | Assign a [[RGB]] color number, corresponding to the color of the text object with an ID number of 3, to Value1 variable: | ||
| − | <syntaxhighlight>Value1=Text_GetColor(3);</syntaxhighlight> | + | <syntaxhighlight>Value1 = Text_GetColor(3);</syntaxhighlight> |
| − | Assign a legacy color value, corresponding to the color of the text object with an ID number of 3, to Value1 variable: | + | Assign a [[LegacyColorValue|legacy color value]], corresponding to the color of the text object with an ID number of 3, to Value1 variable: |
<syntaxhighlight>[LegacyColorValue=True]; | <syntaxhighlight>[LegacyColorValue=True]; | ||
| − | Value1=Text_GetColor(3);</syntaxhighlight> | + | Value1 = Text_GetColor(3);</syntaxhighlight> |
| − | |||
| − | |||
[[Category:Text Drawing]] | [[Category:Text Drawing]] | ||
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);
