RectangleSetBegin

From MultiCharts
Jump to navigation Jump to search

Modifies the starting point location of a rectangle with the specified ID number; returns a value of 0 if the starting point location was successfully modified, and a value of -2 if the specified rectangle ID number is invalid.
Of the two end points of a rectangle, the point with the earlier date and time is always considered to be the starting point; if the rectangle is vertical, the point with the lower price value is considered to be the starting point.

Usage

RectangleSetBegin (ID, sDate, sTime, sPriceValue)
Parameters
ID - a numerical expression specifying the rectangle ID number
sDate - a numerical expression specifying the new starting point date; 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
sTime - a numerical expression specifying the new starting point time; the time is indicated in the 24-hour HHmm format, where 1300 = 1:00 PM
sPriceValue - a numerical expression specifying the new starting point price value (vertical position, corresponding to a value on the price scale of a chart)

Notes

A rectangle-specific ID number is returned by RectangleNew when the rectangle is created.

Example

Move the starting point of the rectangle with an ID number of 1 to 10:00 AM on January 17th at a price value of 1365:

Value1=RectangleSetBegin(1,1080117,1000,1365);