Text GetHStyle: Difference between revisions
From MultiCharts
(→Usage) |
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
||
| Line 1: | Line 1: | ||
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. | 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 == | |||
<syntaxhighlight>Text_GetHStyle(ObjectID)</syntaxhighlight> | |||
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 == | == 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. | ||
Latest revision as of 13:11, 13 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.
- Use Text_SetStyle to set the horizontal placement and vertical placement for 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);