Difference between revisions of "Arw GetTextBGColor"
(→Usage) |
m (Reverted edits by 176.8.90.7 (talk) to last revision by 194.84.116.138) |
||
Line 1: | Line 1: | ||
Returns an RGB color number or a legacy color value that correspond to the text background color of an arrow object with the specified ID number; returns a value of -2 if the specified object ID number is invalid. | Returns an RGB color number or a legacy color value that correspond to the text background color of an arrow object with the specified ID number; returns a value of -2 if the specified object ID number is invalid. | ||
− | + | ==== Usage ==== | |
+ | <syntaxhighlight>Arw_GetTextBGColor(ObjectID)</syntaxhighlight> | ||
+ | Where: ObjectID - a numerical expression specifying the object ID number | ||
+ | |||
==== Notes ==== | ==== Notes ==== | ||
An object-specific ID number is returned by [[Arw_New]] when the arrow object is created. | An object-specific ID number is returned by [[Arw_New]] when the arrow object is created. |
Revision as of 12:42, 13 February 2012
Returns an RGB color number or a legacy color value that correspond to the text background color of an arrow object with the specified ID number; returns a value of -2 if the specified object ID number is invalid.
Usage
Arw_GetTextBGColor(ObjectID)
Where: ObjectID - a numerical expression specifying the object ID number
Notes
An object-specific ID number is returned by Arw_New when the arrow object is created.
Example
Assign an RGB color number, corresponding to the text background color of an arrow object with the ID number of 3, to Value1 variable:
Value1=Arw_GetTextBGColor(3);
Assign a legacy color value, corresponding to the text background color of an arrow object with the ID number of 3, to Value1 variable:
[LegacyColorValue=True];
Value1=Arw_GetTextBGColor(3);