Arw GetTextBGColor: Difference between revisions
From MultiCharts
(Created page with "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 ...") |
(→Notes) |
||
Line 7: | Line 7: | ||
==== Notes ==== | ==== Notes ==== | ||
An object-specific ID number is returned by | An object-specific ID number is returned by [[Arw_New]] when the arrow object is created. | ||
==== Example ==== | ==== 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: | Assign an RGB color number, corresponding to the text background color of an arrow object with the ID number of 3, to Value1 variable: |
Revision as of 13:02, 20 January 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);