Difference between revisions of "Arw GetTextColor"
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 an arrow object with the specified ID number; returns a value of -2 i...") |
|||
| (3 intermediate revisions by 3 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 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. | |
| − | == | + | |
| − | 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: | + | == 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 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]] | ||
Latest revision as of 08:42, 19 February 2012
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.
Arw_GetTextColor returns a value of -2 if the specified object ID number is invalid.
Usage
Arw_GetTextColor(ObjectID)
Where:
- ObjectID - a numerical expression specifying the object ID number.
Notes
- 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 the Value1 variable:
Value1 = Arw_GetTextColor(3);
Assign a 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:
[LegacyColorValue = True];
Value1 = Arw_GetTextColor(3);
