Text GetValue: Difference between revisions
From MultiCharts
(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...") |
No edit summary |
||
| 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 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 == | |||
<syntaxhighlight>Text_GetValue(ObjectID)</syntaxhighlight> | <syntaxhighlight>Text_GetValue(ObjectID)</syntaxhighlight> | ||
Where: | 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. | 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: | 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]] | ||
Revision as of 08:27, 9 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);