Text GetFirst: Difference between revisions
From MultiCharts
(Created page with "Returns a numerical value, indicating an object ID number of the oldest (the first to be added to the current chart) text object of the specified origin; returns a value of -2...") |
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 numerical value, indicating an object ID number of the oldest (the first to be added to the current chart) text object of the specified origin | Returns a numerical value, indicating an object ID number of the oldest (the first to be added to the current chart) text object of the specified origin. | ||
Text_GetFirst returns a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Text_GetFirst (Origin)</syntaxhighlight> | <syntaxhighlight>Text_GetFirst(Origin)</syntaxhighlight> | ||
== Parameters == | |||
:'''Origin''' - a numerical expression specifying the origin of the text object: | |||
1 - added by the current study | ::'''1''' - added by the current study, | ||
2 - added by a study other then the current study, or drawn manually by the user | ::'''2''' - added by a study other then the current study, or drawn manually by the user, | ||
3 - added by any study, or drawn manually by the user | ::'''3''' - added by any study, or drawn manually by the user, | ||
4 - added by the current study, or drawn manually by the user | ::'''4''' - added by the current study, or drawn manually by the user, | ||
5 - added by a study other then the current study | ::'''5''' - added by a study other then the current study, | ||
6 - added by any study | ::'''6''' - added by any study, | ||
7 - added manually by the user | ::'''7''' - added manually by the user. | ||
== Notes == | |||
If the oldest (the first added) text object is deleted, the next oldest (the second added) text object becomes the oldest (the first added) text object. | * If the oldest (the first added) text object is deleted, the next oldest (the second added) text object becomes the oldest (the first added) text object. | ||
* Use [[Text_GetNext]] to get a specific text object on the chart. | |||
== Example == | |||
Assign a value, indicating an object ID number of the oldest text object added to the chart by the current study, to Value1 variable: | Assign a value, indicating an object ID number of the oldest text object added to the chart by the current study, to Value1 variable: | ||
<syntaxhighlight>Value1=Text_GetFirst(1);</syntaxhighlight> | <syntaxhighlight>Value1 = Text_GetFirst(1);</syntaxhighlight> | ||
[[Category:Text Drawing]] | [[Category:Text Drawing]] | ||
Latest revision as of 12:42, 13 February 2012
Returns a numerical value, indicating an object ID number of the oldest (the first to be added to the current chart) text object of the specified origin.
Text_GetFirst returns a value of -2 if the specified object ID number is invalid.
Usage
Text_GetFirst(Origin)Parameters
- Origin - a numerical expression specifying the origin of the text object:
- 1 - added by the current study,
- 2 - added by a study other then the current study, or drawn manually by the user,
- 3 - added by any study, or drawn manually by the user,
- 4 - added by the current study, or drawn manually by the user,
- 5 - added by a study other then the current study,
- 6 - added by any study,
- 7 - added manually by the user.
Notes
- If the oldest (the first added) text object is deleted, the next oldest (the second added) text object becomes the oldest (the first added) text object.
- Use Text_GetNext to get a specific text object on the chart.
Example
Assign a value, indicating an object ID number of the oldest text object added to the chart by the current study, to Value1 variable:
Value1 = Text_GetFirst(1);