Difference between revisions of "Text GetActive"
Jump to navigation
Jump to search
m |
|||
(4 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | Returns a numerical value indicating the object ID number of the currently selected text object. | + | 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 == | == Usage == | ||
<syntaxhighlight>Text_GetActive</syntaxhighlight> | <syntaxhighlight>Text_GetActive</syntaxhighlight> | ||
== Notes == | == Notes == | ||
− | An object-specific ID number is assigned by [[Text_New]] when the text object is created. | + | * An object-specific ID number is assigned by [[Text_New]] when the text object is created. |
− | + | ||
== Example == | == Example == | ||
Assign a value, indicating the object ID number of the currently selected text object, to Value1 variable: | Assign a value, indicating the object ID number of the currently selected text object, to Value1 variable: |
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;