Difference between revisions of "RectangleGetFillColor"

From MultiCharts
Jump to navigation Jump to search
(Created page with "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 recta...")
 
 
Line 2: Line 2:
 
   
 
   
 
== Usage ==
 
== Usage ==
<syntaxhighlight>RectangleGetFillColor(ID)<syntaxhighlight>  
+
<syntaxhighlight>RectangleGetFillColor(ID)</syntaxhighlight>  
 
Where:
 
Where:
 
:'''ID''' - a numerical expression specifying the rectangle ID number  
 
:'''ID''' - a numerical expression specifying the rectangle ID number  
 
   
 
   
 
== Notes ==  
 
== Notes ==  
A rectangle-specific ID number is returned by RectangleNew when the rectangle is created.  
+
A rectangle-specific ID number is returned by [[RectangleNew]] when the rectangle is created.  
 
   
 
   
 
== Example ==
 
== Example ==

Latest revision as of 15:20, 20 August 2021

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);