RectangleSetEnd

From MultiCharts
Jump to navigation Jump to search

Modifies the ending point location of a rectangle with the specified ID number; returns a value of 0 if the ending 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 later date and time is always considered to be the ending point; if the rectangle is vertical, the point with the higher price value is considered to be the ending point.

Usage

RectangleSetEnd (ID, eDate, eTime, ePriceValue)
Parameters
ID - a numerical expression specifying the rectangle ID number
eDate - a numerical expression specifying the new ending 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
eTime - a numerical expression specifying the new ending point time; the time is indicated in the 24-hour HHmm format, where 1300 = 1:00 PM
ePriceValue - a numerical expression specifying the new ending 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 ending point of the rectangle with an ID number of 3 to 14:15 PM on January 17th at a price value of 1350:

Value1=RectangleSetEnd(3,1080117,1415,1350);