Arw SetText

From MultiCharts
Revision as of 13:12, 17 January 2012 by 194.84.116.138 (talk) (Created page with "Adds text to, or replaces the existing text contained in an arrow object with the specified ID number; returns a value of -2 if the specified object ID number is invalid. =...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Adds text to, or replaces the existing text contained in an arrow object with the specified ID number; 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<syntaxhighlight> - the string expression to be displayed in the arrow object 
 
==== Notes ==== 
An object-specific ID number is returned by <syntaxhighlight>Arw_New

when the arrow object is created.

Example

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");