Text GetHStyle

From MultiCharts
Revision as of 13:21, 25 January 2012 by 194.84.116.138 (talk) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

Return

Horizontal placement style:

0 - to the right of the specified bar

1 - to the left of the specified bar

2 - centered on the specified bar

Notes

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:

Value1=Text_GetHStyle(3);