Text GetNext: Difference between revisions
From MultiCharts
(Created page with "Returns an ID number of the first existing text object added subsequent to a text object with the specified ID number, with both objects of a specified origin; returns a value...") |
No edit summary |
||
| Line 1: | Line 1: | ||
Returns an ID number of the first existing text object added subsequent to a text object with the specified ID number, with both objects of a specified origin | Returns an ID number of the first existing text object added subsequent to a text object with the specified ID number, with both objects of a specified origin. | ||
Text_GetNext returns a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Text_GetNext(ObjectID,Origin)</syntaxhighlight> | <syntaxhighlight>Text_GetNext(ObjectID,Origin)</syntaxhighlight> | ||
== Parameters == | |||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
:'''Origin''' - a numerical expression specifying the origin of the text objects: | |||
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 == | ||
* Use [[Text_GetFirst]] to the first text object on the chart. | |||
== Example == | |||
Assign a value to Value1 variable, indicating an ID number of the first existing text object added subsequent to a text object with the ID number of 3, with both objects added by the current study: | Assign a value to Value1 variable, indicating an ID number of the first existing text object added subsequent to a text object with the ID number of 3, with both objects added by the current study: | ||
<syntaxhighlight>Value1=Text_GetNext(3,1);</syntaxhighlight> | <syntaxhighlight>Value1 = Text_GetNext(3, 1);</syntaxhighlight> | ||
[[Category:Text Drawing]] | [[Category:Text Drawing]] | ||
Revision as of 08:33, 9 February 2012
Returns an ID number of the first existing text object added subsequent to a text object with the specified ID number, with both objects of a specified origin.
Text_GetNext returns a value of -2 if the specified object ID number is invalid.
Usage
Text_GetNext(ObjectID,Origin)Parameters
- ObjectID - a numerical expression specifying the object ID number.
- Origin - a numerical expression specifying the origin of the text objects:
- 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
- Use Text_GetFirst to the first text object on the chart.
Example
Assign a value to Value1 variable, indicating an ID number of the first existing text object added subsequent to a text object with the ID number of 3, with both objects added by the current study:
Value1 = Text_GetNext(3, 1);