1,501
edits
(Created page with "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 ==== <s...") |
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
||
(5 intermediate revisions by 2 users not shown) | |||
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> | <syntaxhighlight>Text_GetHStyle(ObjectID)</syntaxhighlight> | ||
Where: | Where: | ||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
0 - to the right of the | 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. | |||
An object-specific ID number is returned by [[Text_New]] when the text object is created. | == Example == | ||
Assign a value, indicating the horizontal placement style of the text object with an ID number of 3, to Value1 variable: | Assign a value, indicating the horizontal placement style of the text object with an ID number of 3, to Value1 variable: | ||
<syntaxhighlight>Value1=Text_GetHStyle(3);</syntaxhighlight> | <syntaxhighlight>Value1 = Text_GetHStyle(3);</syntaxhighlight> | ||
[[Category:Text Drawing]] | [[Category:Text Drawing]] |