Arw SetText

From MultiCharts
Jump to: navigation, search

Adds text to, or replaces the existing text contained in an arrow object with the specified ID number.

Arw_SetText returns a value of -2 if the specified object ID number is invalid.

Usage

Arw_SetText(ObjectID, "Text")

Where:

ObjectID - a numerical expression specifying the object ID number.
Text - the string expression to be displayed in the arrow object.

Notes

Examples

Add text "My Arrow" to the arrow object with an ID number of 3:

Value1 = Arw_SetText(3, "My Arrow");

Replace text contained in the arrow object with an ID number of 3 with the string expression "New Text":

Value1 = Arw_SetText(3, "New Text");