RectangleAnchorToBars: Difference between revisions
From MultiCharts
(Created page with "Anchors the corresponding rectangle drawing to the visible bar index; returns a value of 0 if the operation was performed successfully, and a value of -2 if the specified rect...") |
(→Notes) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
Anchors the corresponding rectangle drawing to the visible bar index; returns a value of 0 if the operation was performed successfully, and a value of -2 if the specified rectangle ID number is invalid. | Anchors the corresponding rectangle drawing to the visible bar index; returns a value of 0 if the operation was performed successfully, and a value of -2 if the specified rectangle ID number is invalid. | ||
Usage | == Usage == | ||
RectangleAnchorToBars(ID,LogicalExpression) | <syntaxhighlight>RectangleAnchorToBars(ID,LogicalExpression)</syntaxhighlight> | ||
Where: | Where: | ||
:'''ID''' - is a numerical expression specifying the rectangle ID number | |||
:'''LogicalExpression''' - is a logical value; True = Add option and False = Remove option | |||
== Notes == | |||
A rectangle-specific ID number is returned by [[RectangleNew]] when the rectangle is created. | |||
== Example == | |||
Example | |||
Anchor the rectangle with an ID number of 3 to the visible bar index: | Anchor the rectangle with an ID number of 3 to the visible bar index: | ||
Value1=RectangleAnchorToBars(3,True); | <syntaxhighlight>Value1=RectangleAnchorToBars(3,True);</syntaxhighlight> | ||
[[Category: Rectangle Drawing]] | [[Category: Rectangle Drawing]] | ||
Latest revision as of 14:50, 19 August 2021
Anchors the corresponding rectangle drawing to the visible bar index; returns a value of 0 if the operation was performed successfully, and a value of -2 if the specified rectangle ID number is invalid.
Usage
RectangleAnchorToBars(ID,LogicalExpression)Where:
- ID - is a numerical expression specifying the rectangle ID number
- LogicalExpression - is a logical value; True = Add option and False = Remove option
Notes
A rectangle-specific ID number is returned by RectangleNew when the rectangle is created.
Example
Anchor the rectangle with an ID number of 3 to the visible bar index:
Value1=RectangleAnchorToBars(3,True);