Text SetLocation DT

From MultiCharts
Jump to: navigation, search

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.

Usage

Text_SetLocation_DT (ObjectID, Bar_DateTime, PriceValue)

Parameters

  • ObjectID - a numerical expression specifying the object ID number
  • Bar_DateTime - a numerical expression specifying the date and time of the bar at which the object is to be placed; the date is indicated in the DateTime format, where the integer portion of the DateTime value indicates the number of days that have elapsed since January 1st, 1900, and the fractional portion of the DateTime value indicates the fraction of the day that has passed since midnight. DateTime is a floating point value with high precision. It allows accessing millisecond time stamps of the bar.
  • 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 when the text object is created.

Example

Move the text object with an ID number of 3 to the top of the current bar:

Value1=Text_SetLocation_DT(3,DateTime,High);