Text SetStyle

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Sets the placement style of a text object relative to the bar and to the price value specified for the object.

Text_SetStyle returns a value of 0 if the placement style of the object was successfully modified, and a value of -2 if the specified object ID number is invalid.

Usage

Text_SetStyle (ObjectID, HorizPl, VertPl)

Parameters

ObjectID - a numerical expression specifying the object ID number.

HorizPl - a numerical expression specifying the horizontal placement style for the text object:

0 - to the right of the specified bar,

1 - to the left of the specified bar,

2 - centered on the specified bar .

VertPl - a numerical expression specifying the vertical placement style for the text 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 and Text_GetVStyle to get the text object's horizontal and vertical placement.

Example

Center the text object with an ID number of 3 on the bar and on the price value, specified for the object:

Value1 = Text_SetStyle(3, 2, 2);