Difference between revisions of "Text GetValue"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Returns the price value (vertical position, corresponding to a value on the price scale of a chart), at which a text object with the specified ID number has been placed; retur...")
 
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Returns the price value (vertical position, corresponding to a value on the price scale of a chart), at which a text object with the specified ID number has been placed; returns a value of -2 if the specified object ID number is invalid.  
+
Returns the price value (vertical position, corresponding to a value on the price scale of a chart), at which a text object with the specified ID number has been placed.
 +
 
 +
Text_GetValue returns a value of -2 if the specified object ID number is invalid.  
 
   
 
   
==== Usage ====
+
== Usage ==
 
<syntaxhighlight>Text_GetValue(ObjectID)</syntaxhighlight>  
 
<syntaxhighlight>Text_GetValue(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.
+
 
==== Example ====
+
== Example ==
 
Assign a value, indicating the price value at which a text object with the ID number of 3 has been placed, to Value1 variable:  
 
Assign a value, indicating the price value at which a text object with the ID number of 3 has been placed, to Value1 variable:  
  
<syntaxhighlight>Value1=Text_GetValue(3);</syntaxhighlight>  
+
<syntaxhighlight>Value1 = Text_GetValue(3);</syntaxhighlight>  
 
   
 
   
 
[[Category:Text Drawing]]
 
[[Category:Text Drawing]]

Latest revision as of 12:38, 13 February 2012

Returns the price value (vertical position, corresponding to a value on the price scale of a chart), at which a text object with the specified ID number has been placed.

Text_GetValue returns a value of -2 if the specified object ID number is invalid.

Usage

Text_GetValue(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.

Example

Assign a value, indicating the price value at which a text object with the ID number of 3 has been placed, to Value1 variable:

Value1 = Text_GetValue(3);