Text GetHStyle: Difference between revisions
From MultiCharts
No edit summary |
No edit summary |
||
| Line 8: | Line 8: | ||
:'''ObjectID''' - a numerical expression specifying the object ID number. | :'''ObjectID''' - a numerical expression specifying the object ID number. | ||
Returns a | Returns a numerical value indicating the horizontal placement style of the specified object: | ||
:'''0''' - to the right of the bar, | :'''0''' - to the right of the bar, | ||
| Line 15: | Line 15: | ||
== Notes == | == 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_GetVStyle]] to get the vertical placement of a text object. | |||
== Example == | == Example == | ||
Revision as of 08:26, 9 February 2012
Returns the horizontal 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
Text_GetHStyle(ObjectID)Where:
- ObjectID - a numerical expression specifying the object ID number.
Returns a numerical value indicating the horizontal placement style of the specified object:
- 0 - to the right of the bar,
- 1 - to the left of the bar,
- 2 - centered on the bar.
Notes
- An object-specific ID number is returned by Text_New when the text object is created.
- Use Text_GetVStyle to get the vertical placement of a text object.
Example
Assign a value, indicating the horizontal placement style of the text object with an ID number of 3, to Value1 variable:
Value1=Text_GetHStyle(3);