Changes
Created page with "Returns the vertical placement style of a text object with the specified ID number; returns a value of -2 if the specified object ID number is invalid. ==== Usage ==== <syn..."
Returns the vertical placement style of a text object with the specified ID number; 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:
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.
==== 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]]
==== Usage ====
<syntaxhighlight>Text_GetVStyle(ObjectID)</syntaxhighlight>
Where: [[ObjectID]] - a numerical expression specifying the object ID number
==== Return ====
Vertical placement style:
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.
==== 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]]