Text GetActive: Difference between revisions
From MultiCharts
(→Notes) |
No edit summary |
||
(One intermediate revision by one other user 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 text object. | ||
Text_GetActive returns | Text_GetActive returns -1 if no text objects are currently selected or were added to a chart yet. | ||
If an active text drawing object is removed from a chart then GetActive returns -1. | |||
If an inactive text drawing object is removed from a chart then GetActive returns the object ID number of the currently active text object. | |||
== Usage == | |||
<syntaxhighlight>Text_GetActive</syntaxhighlight> | |||
== Notes == | |||
* An object-specific ID number is assigned by [[Text_New]] when the text object is created. | |||
== Example == | == Example == |
Latest revision as of 14:29, 13 October 2014
Returns a numerical value indicating the object ID number of the currently active text object.
Text_GetActive returns -1 if no text objects are currently selected or were added to a chart yet. If an active text drawing object is removed from a chart then GetActive returns -1. If an inactive text drawing object is removed from a chart then GetActive returns the object ID number of the currently active text object.
Usage
Text_GetActive
Notes
- An object-specific ID number is assigned by Text_New when the text object is created.
Example
Assign a value, indicating the object ID number of the currently selected text object, to Value1 variable:
Value1 = Text_GetActive;