×

Sign up and get MultiCharts free

Use its powerful simulation mode with data included out of the box. Just fill out the form and start honing your trading skills with a few clicks.

Changes - MultiCharts

Changes

Jump to navigation Jump to search

Text GetVStyle

250 bytes added, 12:42, 13 February 2012
m
Reverted edits by 176.8.90.7 (talk) to last revision by JoshM
Returns the vertical placement style of a text object with the specified ID number; . Text_GetVStyle returns a value of -2 if the specified object ID number is invalid.
==== Usage ====
<syntaxhighlight>Text_GetVStyle(ObjectID)</syntaxhighlight>
Where: [[ObjectID]] - a numerical expression specifying the object ID number
==== Return ==== Vertical placement style: '''ObjectID''' - a numerical expression specifying the object ID number.
Returns a numerical value indicating the vertical placement style of the specified object: :'''0 ''' - below the specified price value
:'''1 ''' - above the specified price value
:'''2 ''' - centered on the specified price value
Price value represents the vertical position corresponding to a value on the price scale of a chart.
==== Notes ==== * An object-specific ID number is returned by [[Text_New]] when the text object is created. * Use [[Text_GetHStyle]] to get the horizontal placement of a text object.* Use [[Text_SetStyle]] to set the horizontal placement and vertical placement for a text object. ==== Example ====
Assign a value, indicating the vertical placement style of the text object with an ID number of 3, to Value1 variable:
<syntaxhighlight>Value1=Text_GetVStyle(3);</syntaxhighlight>  
[[Category:Text Drawing]]

Navigation menu