RectangleGetFillColor

From MultiCharts
Jump to navigation Jump to search

Returns an RGB color number or a legacy color value that correspond to the fill color of a rectangle with the specified ID number; returns a value of -2 if the specified rectangle ID number is invalid.

Usage

RectangleGetFillColor(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 an RGB color number, corresponding to the fill color of a rectangle with the ID number of 1, to Value1 variable:

Value1=RectangleGetFillColor(1);

Assign a legacy color value, corresponding to the fill color of a rectangle with the ID number of 2, to Value1 variable:

[LegacyColorValue=True];
Value1=RectangleGetColor(2);