Text SetLocation s: Difference between revisions
From MultiCharts
(Created page with "Modifies the location of a text object with the specified ID number; returns a value of 0 if the location of the object was successfully modified, and a value of -2 if the spe...") |
No edit summary |
||
Line 1: | Line 1: | ||
Modifies the location of a text object with the specified ID number | Modifies the location of a text object with the specified ID number. | ||
Text_SetLocation_s returns a value of 0 if the location of the object was successfully modified, and a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Text_SetLocation_s (ObjectID, BarDate, BarTime_s, PriceValue)</syntaxhighlight> | <syntaxhighlight>Text_SetLocation_s (ObjectID, BarDate, BarTime_s, PriceValue)</syntaxhighlight> | ||
== Parameters == | |||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
:'''BarDate''' - a numerical expression specifying the date of the bar at which the object is to be placed; the date is indicated in the ''YYYMMdd'' format, where YYY is the number of years since 1900, MM is the month, and dd is the day of the month. | |||
:'''BarTime_s''' - a numerical expression specifying the time of the bar, including seconds, at which the object is to be placed; the time is indicated in the 24-hour ''HHmmss'' format, where 130000 = 1:00:00 PM. | |||
:'''PriceValue''' - a numerical expression specifying the price value (vertical position, corresponding to a value on the price scale of a chart), where the object is to be placed. | |||
== Notes == | |||
An object-specific ID number is returned by [[Text_New_s]]when the text object is created. | * An object-specific ID number is returned by [[Text_New_s]]when the text object is created. | ||
* Use [[Text_SetLocation]] to set the location of a text object with minute precision. | |||
== Example == | |||
Move the text object with an ID number of 3 to the top of the current bar: | Move the text object with an ID number of 3 to the top of the current bar: | ||
<syntaxhighlight>Value1=Text_SetLocation_s(3,Date,Time_s,High);</syntaxhighlight> | <syntaxhighlight>Value1 = Text_SetLocation_s(3, Date, Time_s, High);</syntaxhighlight> | ||
[[Category:Text Drawing]] | [[Category:Text Drawing]] |
Revision as of 08:39, 9 February 2012
Modifies the location of a text object with the specified ID number.
Text_SetLocation_s returns a value of 0 if the location of the object was successfully modified, and a value of -2 if the specified object ID number is invalid.
Usage
Text_SetLocation_s (ObjectID, BarDate, BarTime_s, PriceValue)
Parameters
- ObjectID - a numerical expression specifying the object ID number.
- BarDate - a numerical expression specifying the date of the bar at which the object is to be placed; the date is indicated in the YYYMMdd format, where YYY is the number of years since 1900, MM is the month, and dd is the day of the month.
- BarTime_s - a numerical expression specifying the time of the bar, including seconds, at which the object is to be placed; the time is indicated in the 24-hour HHmmss format, where 130000 = 1:00:00 PM.
- PriceValue - a numerical expression specifying the price value (vertical position, corresponding to a value on the price scale of a chart), where the object is to be placed.
Notes
- An object-specific ID number is returned by Text_New_swhen the text object is created.
- Use Text_SetLocation to set the location of a text object with minute precision.
Example
Move the text object with an ID number of 3 to the top of the current bar:
Value1 = Text_SetLocation_s(3, Date, Time_s, High);