Difference between revisions of "CommentaryEnabled"

From MultiCharts
Jump to navigation Jump to search
m
 
Line 1: Line 1:
This reserved word returns a value of True only when the Expert Commentary window is open and Commentary has been requested. This allows you to optimize your trading strategies, analysis techniques, and functions for speed, as it allows PowerLanguage to perform commentary-related calculations only when the Expert Commentary window is open.
+
This reserved word returns a value of True only when the [[:Category:Expert_Commentary|Expert Commentary]] window is open and Commentary has been requested.  
  
'''Usage'''
+
This allows you to optimize your trading strategies, analysis techniques, and functions for speed, as it allows PowerLanguage to perform commentary-related calculations only when the Expert Commentary window is open.
 +
 
 +
== Usage ==
 
<syntaxhighlight>
 
<syntaxhighlight>
 
CommentaryEnabled
 
CommentaryEnabled
 
</syntaxhighlight>
 
</syntaxhighlight>
  
The difference between [[CommentaryEnabled]] and [[AtCommentaryBar]] is that [[CommentaryEnabled]] returns a value of True for ALL bars when the Expert Commentary window is open, while the [[AtCommentaryBar]] returns a value of True only for the bar clicked with the Expert Commentary pointer.
+
== Notes ==
 +
* The difference between [[CommentaryEnabled]] and [[AtCommentaryBar]] is that [[CommentaryEnabled]] returns a value of True for ALL bars when the Expert Commentary window is open, while the [[AtCommentaryBar]] returns a value of True only for the bar clicked with the Expert Commentary pointer.
  
'''Example'''
+
== Example ==
 
<syntaxhighlight>
 
<syntaxhighlight>
 
CommentaryEnabled
 
CommentaryEnabled
</syntaxhighlight> will return True if the Expert Commentary Tool has been applied to the chart.
+
</syntaxhighlight>  
 +
Will return True if the Expert Commentary Tool has been applied to the chart.
  
 
[[Category:Expert Commentary]]
 
[[Category:Expert Commentary]]

Latest revision as of 05:46, 3 April 2013

This reserved word returns a value of True only when the Expert Commentary window is open and Commentary has been requested.

This allows you to optimize your trading strategies, analysis techniques, and functions for speed, as it allows PowerLanguage to perform commentary-related calculations only when the Expert Commentary window is open.

Usage

CommentaryEnabled

Notes

Example

CommentaryEnabled

Will return True if the Expert Commentary Tool has been applied to the chart.