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...")
 
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
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 specified object ID number is invalid.  
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 ====
== Usage ==
<syntaxhighlight>Text_SetLocation_s (ObjectID, BarDate, BarTime_s, PriceValue)</syntaxhighlight>  
<syntaxhighlight>Text_SetLocation_s (ObjectID, BarDate, BarTime_s, PriceValue)</syntaxhighlight>  


==== Parameters ====  
== Parameters ==  
[[ObjectID]] - a numerical expression specifying the object ID number  
:'''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  
:'''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  
:'''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  
:'''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 ====  
== 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 modify the location of a text object with minute precision.
==== Example ====
* Use [[Text_GetTime]], [[Text_GetTime_s]] and [[Text_GetDate]] to get the location of a specific text object.
 
== 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]]

Latest revision as of 12:38, 13 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

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);