Difference between revisions of "Text GetActive"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Returns a numerical value indicating the object ID number of the currently selected text object; returns a value of -1 if no text objects are currently selected. ==== Usage...")
 
m
Line 1: Line 1:
Returns a numerical value indicating the object ID number of the currently selected text object; returns a value of -1 if no text objects are currently selected.  
+
Returns a numerical value indicating the object ID number of the currently selected text object.
 +
 
 +
Text_GetActive returns a value of -1 if no text objects are currently selected.  
 
   
 
   
==== 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:  
  
<syntaxhighlight>Value1=Text_GetActive;</syntaxhighlight>  
+
<syntaxhighlight>Value1 = Text_GetActive;</syntaxhighlight>  
 
   
 
   
 
[[Category:Text Drawing]]
 
[[Category:Text Drawing]]

Revision as of 08:06, 9 February 2012

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

Text_GetActive returns a value of -1 if no text objects are currently selected.

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;