RectangleSetEnd BN

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.
Between 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.
Instead of separate Date and Time values or a single DateTime value, bar number is used.

Usage

RectangleSetEnd_BN (ID, BarNumber, Price);
Parameters
ID - a numerical expression specifying the rectangle ID number.
BarNumber - a numerical expression specifying the rectangle ending point bar number.
Price - a numerical expression specifying the rectangle ending point price value.

Example

Set the ending point of rectangle with ID = 1 to close price of the current bar

Value1=RectangleSetEnd_BN(1,currentbar,Close);