TL GetActive: Difference between revisions

Latest revision as of 14:32, 13 October 2014

This reserved word returns a numeric value representing the ID of the currently active trendline.

TL_GetActive returns -1 if no trendlines are currently selected or were added to a chart yet. If an active trendline is removed from a chart then TL_GetActive returns -1. If an inactive trendline is removed from a chart then TL_GetActive returns the object ID number of the currently active trendline.

Usage

TL_GetActive

Notes

TL_GetActive should be assigned to a numeric variable or array in order to determine if the operation is performed successfully. In other words, if the returning value of TL_GetActive isn't saved, it's not possible to check whether or not the selection of the trendline succeeded.

Example

Value1 = TL_GetActive;

Assigns the ID of the currently active trendline to the Value1 variable. The variable to which the returning value is assigned can be a numeric variable or numeric array.

@@ Line 1: / Line 1: @@
 This reserved word returns a numeric value representing the ID of the currently active trendline.
-==== Usage ====
+TL_GetActive returns -1 if no trendlines are currently selected or were added to a chart yet.
+If an active trendline is removed from a chart then TL_GetActive returns -1.
+If an inactive trendline is removed from a chart then TL_GetActive returns the object ID number of the currently active trendline.
+== Usage ==
 <syntaxhighlight>TL_GetActive</syntaxhighlight>
-==== Notes ====
+== Notes ==
-When the reserved word performs its operation successfully, trendline ID is returned.
+* TL_GetActive should be assigned to a [[Variable|numeric variable]] or [[Array|array]] in order to determine if the operation is performed successfully. In other words, if the returning value of TL_GetActive isn't saved, it's not possible to check whether or not the selection of the trendline succeeded.
-When a reserved word cannot perform its operation, it returns an error code.
-==== Example ====
+== Example ==
-<syntaxhighlight>Value1=TL_GetActive;</syntaxhighlight>
+<syntaxhighlight>Value1 = TL_GetActive;</syntaxhighlight>
-Assigns the ID of the currently active trendline to Value1.
+Assigns the ID of the currently active trendline to the Value1 variable. The variable to which the returning value is assigned can be a numeric variable or numeric array.
-Value1 is any numeric variable or array.
-Trendline reserved word should be assigned to a numeric variable or array in order to determine whether the reserved word performed its operation successfully or not.
 [[Category:Trendline Drawing]]