Arw GetColor: Difference between revisions
From MultiCharts
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 arrow contained in an arrow object with the specified ID number | Returns an RGB color number or a legacy color value that correspond to the color of the arrow contained in an arrow object with the specified ID number. | ||
Arw_GetColor returns a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight> | <syntaxhighlight> | ||
Arw_GetColor(ObjectID) | Arw_GetColor(ObjectID) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Where: | 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. | * An object-specific ID number is returned by [[Arw_New]] or [[Arw_New_s]] when the arrow object is created. | ||
* Use [[Arw_SetColor]] to set the color of a specified arrow. | |||
== | == Examples == | ||
Assign an RGB color number, corresponding to the color of the arrow 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 arrow contained in an arrow object with the ID number of 3, to Value1 variable: | ||
<syntaxhighlight> | <syntaxhighlight> | ||
Value1=Arw_GetColor(3); | Value1 = Arw_GetColor(3); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Assign a legacy color value, corresponding to the color of the arrow 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 arrow contained in an arrow object with the ID number of 3, to Value1 variable: | ||
<syntaxhighlight> | <syntaxhighlight> | ||
[LegacyColorValue=True]; | [LegacyColorValue = True]; | ||
Value1=Arw_GetColor(3); | Value1 = Arw_GetColor(3); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Revision as of 08:02, 19 February 2012
Returns an RGB color number or a legacy color value that correspond to the color of the arrow contained in an arrow object with the specified ID number.
Arw_GetColor returns a value of -2 if the specified object ID number is invalid.
Usage
Arw_GetColor(ObjectID)Where:
- ObjectID - a numerical expression specifying the object ID number.
Notes
- An object-specific ID number is returned by Arw_New or Arw_New_s when the arrow object is created.
- Use Arw_SetColor to set the color of a specified arrow.
Examples
Assign an RGB color number, corresponding to the color of the arrow contained in an arrow object with the ID number of 3, to Value1 variable:
Value1 = Arw_GetColor(3);Assign a legacy color value, corresponding to the color of the arrow contained in an arrow object with the ID number of 3, to Value1 variable:
[LegacyColorValue = True];
Value1 = Arw_GetColor(3);