Difference between revisions of "Text GetVStyle"
Jump to navigation
Jump to search
(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...") |
|||
| Line 1: | Line 1: | ||
| − | Returns the vertical placement style of a text object with the specified ID number | + | 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> | <syntaxhighlight>Text_GetVStyle(ObjectID)</syntaxhighlight> | ||
| − | Where: | + | Where: |
| − | + | :'''ObjectID''' - a numerical expression specifying the object ID number. | |
| − | |||
| − | 0 - below the specified price value | + | 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 | + | :'''1''' - above the specified price value |
| − | 2 - centered on 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. | 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. | + | * 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. | ||
| − | + | == Example == | |
Assign a value, indicating the vertical placement style of the text object with an ID number of 3, to Value1 variable: | 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> | + | <syntaxhighlight>Value1 = Text_GetVStyle(3);</syntaxhighlight> |
| − | |||
[[Category:Text Drawing]] | [[Category:Text Drawing]] | ||
Revision as of 08:26, 9 February 2012
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
Text_GetVStyle(ObjectID)
Where:
- 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.
Example
Assign a value, indicating the vertical placement style of the text object with an ID number of 3, to Value1 variable:
Value1 = Text_GetVStyle(3);
