Text SetAttribute

From MultiCharts
Jump to: navigation, search

Sets an attribute of the text in a text object with the specified ID number.

Text_SetAttribute returns a value of 0 if the attribute was successfully set, and a value of -2 if the specified object ID number is invalid.

The following text attributes can be set: border, bold, italic, strike-out, and underline.

Usage

Text_SetAttribute(ObjectID, Attribute, LogicalExpression)

Parameters

ObjectID - a numerical expression specifying the object ID number.
Attribute - a numerical expression specifying the attribute:
0 - border,
1 - bold,
2 - italic,
3 - strike-out,
4 - underline.
LogicalExpression - a logical value; True = on and False = off.

Notes

  • An object-specific ID number is returned by Text_New when the text object is created.
  • Use Text_GetAttribute to get the attribute of a text object.

Example

Set the attribute "bold" to on for the text in a text object with the ID number of 3:

Value1 = Text_SetAttribute(3, 1, True);