Arw GetTextAttribute

From MultiCharts
Jump to: navigation, search

Returns a logical value indicating the setting for an attribute of the text in an arrow object with the specified ID number.

Arw_GetTextAttribute returns a value of True if the attribute is set to on, and a value of False if the attribute is set to off or if the specified object ID number is invalid.

The settings of the following attributes can be returned: border, bold, italic, strike-out, and underline.

Usage

Arw_GetTextAttribute(ObjectID, Attribute)

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.

Notes

Example

Assign a true/false value, indicating the setting of "bold" attribute for the arrow object with an ID number of 3, to the ArwTxtBold variable:

Variable: ArwTxtBold(False); 
 
ArwTxtBold = Arw_GetTextAttribute(3, 1);