Difference between revisions of "TL SetStyle"

From MultiCharts
Jump to navigation Jump to search
m (Reverted edits by 176.8.90.7 (talk) to last revision by 194.84.116.138)
m (Removed dead links)
Line 1: Line 1:
Assigns the specified style to a trendline with the specified ID number; returns a value of 0 if the trendline style was successfully assigned, and a value of -2 if the specified trendline ID number is invalid.  
+
Assigns the specified style to a trendline with the specified ID number.
 +
 
 +
TL_SetStyle returns a value of 0 if the trendline style was successfully assigned, and a value of -2 if the specified trendline ID number is invalid.  
 
   
 
   
==== Usage ====
+
== Usage ==
 
<syntaxhighlight>TL_SetStyle(TL_ID,TL_Style)</syntaxhighlight>  
 
<syntaxhighlight>TL_SetStyle(TL_ID,TL_Style)</syntaxhighlight>  
  
==== Parameters ====  
+
== Parameters ==  
[[TL_ID]] - a numerical expression specifying the trendline ID number  
+
:'''TL_ID''' - a numerical expression specifying the trendline ID number.
 +
 
 +
:'''TL_Style''' - a TL style constant or a numerical expression specifying the trendline style as follows:
  
[[TL_Style]] - a TL style constant or a numerical expression specifying the trendline style as follows:  
+
::{|
{|
 
 
|Tool_Solid  
 
|Tool_Solid  
 
|1  
 
|1  
Line 15: Line 18:
 
|Tool_Dashed  
 
|Tool_Dashed  
 
|2  
 
|2  
|[[- - - - - - - - - - - - - - - - - - -]]
+
|<nowiki>- - - - - - - - - - - - - - - - - - -</nowiki>
 
|-  
 
|-  
 
|Tool_Dotted  
 
|Tool_Dotted  
Line 30: Line 33:
 
|}
 
|}
 
   
 
   
==== Notes ====  
+
== Notes ==
A trendline-specific ID number is returned by [[TL_New]] when the trendline is created.  
+
* A trendline specific ID number is returned by [[TL_New]] when the trendline is created.  
 
   
 
   
==== Example ====
+
== Example ==
 
Set the style of the trendline with an ID number of 3 to Tool Dashed:  
 
Set the style of the trendline with an ID number of 3 to Tool Dashed:  
  
<syntaxhighlight>Value1=TL_SetStyle(3, 2);</syntaxhighlight>
+
<syntaxhighlight>Value1 = TL_SetStyle(3, 2);</syntaxhighlight>
  
 
Set the style of the trendline with an ID number of 3 to Tool Dashed:  
 
Set the style of the trendline with an ID number of 3 to Tool Dashed:  
  
<syntaxhighlight>Value1=TL_SetStyle(3, Tool_Dashed);</syntaxhighlight>  
+
<syntaxhighlight>Value1 = TL_SetStyle(3, Tool_Dashed);</syntaxhighlight>  
 
   
 
   
 
[[Category:Trendline Drawing]]
 
[[Category:Trendline Drawing]]

Revision as of 05:36, 3 April 2013

Assigns the specified style to a trendline with the specified ID number.

TL_SetStyle returns a value of 0 if the trendline style was successfully assigned, and a value of -2 if the specified trendline ID number is invalid.

Usage

TL_SetStyle(TL_ID,TL_Style)

Parameters

TL_ID - a numerical expression specifying the trendline ID number.
TL_Style - a TL style constant or a numerical expression specifying the trendline style as follows:
Tool_Solid 1 ______________________
Tool_Dashed 2 - - - - - - - - - - - - - - - - - - -
Tool_Dotted 3 ............................................
Tool_Dashed2 4 __ _ __ _ __ _ __ _ __ _ __
Tool_Dashed3 5 ___ _ _ ___ _ _ ___ _ _ ___

Notes

  • A trendline specific ID number is returned by TL_New when the trendline is created.

Example

Set the style of the trendline with an ID number of 3 to Tool Dashed:

Value1 = TL_SetStyle(3, 2);

Set the style of the trendline with an ID number of 3 to Tool Dashed:

Value1 = TL_SetStyle(3, Tool_Dashed);