Difference between revisions of "Arw GetActive"

From MultiCharts
Jump to navigation Jump to search
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Returns a numerical value indicating the object ID number of the currently selected arrow object.
+
Returns a numerical value indicating the object ID number of the currently active arrow object.
  
Arw_GetActive returns a value of -1 if no arrow objects are currently selected.  
+
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 ==
 
== Usage ==
Line 9: Line 11:
  
 
== Notes ==
 
== 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.  
+
* 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 ==
 
== Example ==

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

Example

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

Value1 = Arw_GetActive;