Arw GetTextColor: Difference between revisions
From MultiCharts
no edit summary
m (Reverted edits by 176.8.90.7 (talk) to last revision by 194.84.116.138) |
No edit summary |
||
Line 1: | Line 1: | ||
Returns an RGB color number or a legacy color value that correspond to the color of the text contained in an arrow object with the specified ID number | Returns an [[RGB]] color number or a [[LegacyColorValue|legacy color value]] that correspond to the color of the text contained in an arrow object with the specified ID number. | ||
Arw_GetTextColor returns a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Arw_GetTextColor(ObjectID)</syntaxhighlight> | <syntaxhighlight>Arw_GetTextColor(ObjectID)</syntaxhighlight> | ||
Where: ObjectID - a numerical expression specifying the object ID number | Where: | ||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
== Notes == | |||
An object-specific ID number is | * An object-specific ID number is assigned by [[Arw_New]], [[Arw_New_s]], [[Arw_New_self]] or [[Arw_New_self_s]] when the arrow object is created. | ||
* Use [[Arw_GetActive]], [[Arw_GetFirst]] or [[Arw_GetNext]] to get the object-specific ID number of an already created arrow. | |||
== | == Examples == | ||
Assign an RGB color number, corresponding to the color of the text contained in an arrow object with the ID number of 3, to Value1 variable: | Assign an [[RGB]] color number, corresponding to the color of the text contained in an arrow object with the ID number of 3, to the Value1 variable: | ||
<syntaxhighlight>Value1=Arw_GetTextColor(3);</syntaxhighlight> | <syntaxhighlight>Value1 = Arw_GetTextColor(3);</syntaxhighlight> | ||
Assign a legacy color value, corresponding to the color of the text contained in an arrow object with the ID number of 3, to Value1 variable: | Assign a [[LegacyColorValue|legacy color value]], corresponding to the color of the text contained in an arrow object with the ID number of 3, to the Value1 variable: | ||
<syntaxhighlight>[LegacyColorValue=True]; | <syntaxhighlight>[LegacyColorValue = True]; | ||
Value1 = Arw_GetTextColor(3);</syntaxhighlight> | |||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] |