Difference between revisions of "Arw GetActive"
Jump to navigation
Jump to search
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Returns a numerical value indicating the object ID number of the currently | + | Returns a numerical value indicating the object ID number of the currently active arrow object. |
| − | + | Arw_GetActive returns -1 if no arrow objects are currently selected or were added to a chart yet. | |
| + | If an active arrow drawing object is removed from a chart then Arw_GetActive returns -1. | ||
| + | If an inactive arrow drawing object is removed from a chart then Arw_GetActive returns the object ID number of the currently active arrow object. | ||
| + | |||
| + | == Usage == | ||
<syntaxhighlight> | <syntaxhighlight> | ||
Arw_GetActive | Arw_GetActive | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | == Notes == | |
| − | An object-specific ID number is assigned by Arw_New when the arrow object is created. | + | * 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 [[MC_Arw_GetActive]] to get the '''arrow ID''' number of the currently selected arrow. | ||
| − | + | == Example == | |
Assign a value, indicating the object ID number of the currently selected arrow object, to Value1 variable: | Assign a value, indicating the object ID number of the currently selected arrow object, to Value1 variable: | ||
<syntaxhighlight> | <syntaxhighlight> | ||
| − | Value1=Arw_GetActive; | + | Value1 = Arw_GetActive; |
</syntaxhighlight> | </syntaxhighlight> | ||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Latest revision as of 14:36, 13 October 2014
Returns a numerical value indicating the object ID number of the currently active arrow object.
Arw_GetActive returns -1 if no arrow objects are currently selected or were added to a chart yet. If an active arrow drawing object is removed from a chart then Arw_GetActive returns -1. If an inactive arrow drawing object is removed from a chart then Arw_GetActive returns the object ID number of the currently active arrow object.
Usage
Arw_GetActive
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 MC_Arw_GetActive to get the arrow ID number of the currently selected arrow.
Example
Assign a value, indicating the object ID number of the currently selected arrow object, to Value1 variable:
Value1 = Arw_GetActive;
