Difference between revisions of "Text GetString"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Returns a string expression corresponding to the text contained in a text object with the specified ID number. ==== Usage ==== <syntaxhighlight>Text_GetString(ObjectID)</sy...")
 
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
Returns a string expression corresponding to the text contained in a text object with the specified ID number.  
 
Returns a string expression corresponding to the text contained in a text object with the specified ID number.  
 
   
 
   
==== Usage ====
+
== Usage ==
 
<syntaxhighlight>Text_GetString(ObjectID)</syntaxhighlight>  
 
<syntaxhighlight>Text_GetString(ObjectID)</syntaxhighlight>  
  
Where: [[ObjectID]] - a numerical expression specifying the object ID number  
+
Where:  
 +
 
 +
:'''ObjectID''' - a numerical expression specifying the object ID number.
 
   
 
   
==== Notes ====
+
== Notes ==
An object-specific ID number is returned by [[Text_New]] when the text object is created.  
+
* An object-specific ID number is returned by [[Text_New]] when the text object is created.
+
* Use [[Text_SetString]] to set the string expression of a text object.
==== Example ====
+
 
<syntaxhighlight>Text_GetString(3) will return a string expression corresponding to the text contained in the text  
+
== Example ==
object with an ID number of 3</syntaxhighlight>
+
<syntaxhighlight>Text_GetString(3);</syntaxhighlight>
 +
Will return a string expression corresponding to the text contained in the text object with an ID number of 3.
 
   
 
   
 
[[Category:Text Drawing]]
 
[[Category:Text Drawing]]

Latest revision as of 13:10, 13 February 2012

Returns a string expression corresponding to the text contained in a text object with the specified ID number.

Usage

Text_GetString(ObjectID)

Where:

ObjectID - a numerical expression specifying the object ID number.

Notes

  • An object-specific ID number is returned by Text_New when the text object is created.
  • Use Text_SetString to set the string expression of a text object.

Example

Text_GetString(3);

Will return a string expression corresponding to the text contained in the text object with an ID number of 3.