RectangleGetBeginPrice

From MultiCharts
Jump to navigation Jump to search

Returns the price value (vertical position, corresponding to a value on the price scale of a chart) of the starting point of a rectangle with the specified ID number; returns 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

RectangleGetBeginPrice(ID)

Where: ID - a numerical expression specifying the rectangle ID number

Notes

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

Example

Assign a value, indicating the price value of the starting point of a rectangle with the ID number of 3, to Value1 variable:

Value1=RectangleGetBeginPrice(3);