Difference between revisions of "Arw GetActive"

From MultiCharts
Jump to navigation Jump to search
Line 1: Line 1:
Returns a numerical value indicating the object ID number of the currently selected arrow object; returns a value of -1 if no arrow objects are currently selected.  
+
Returns a numerical value indicating the object ID number of the currently selected arrow object.
  
==== Usage ====
+
Arw_GetActive returns a value of -1 if no arrow objects are currently selected.
 +
 
 +
== Usage ==
 
<syntaxhighlight>
 
<syntaxhighlight>
 
Arw_GetActive  
 
Arw_GetActive  
 
</syntaxhighlight>
 
</syntaxhighlight>
  
==== Notes ====
+
== 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.  
  
==== Example ====
+
== 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]]

Revision as of 08:04, 19 February 2012

Returns a numerical value indicating the object ID number of the currently selected arrow object.

Arw_GetActive returns a value of -1 if no arrow objects are currently selected.

Usage

Arw_GetActive

Notes

Example

Assign a value, indicating the object ID number of the currently selected arrow object, to Value1 variable:

Value1 = Arw_GetActive;