Difference between revisions of "Text GetVStyle"
Jump to navigation
Jump to search
m (→Notes) |
|||
| Line 23: | Line 23: | ||
* 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. | * 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 == | == 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: | ||
Revision as of 08:55, 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.
- 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:
Value1 = Text_GetVStyle(3);
