+1 888 340 6572

Arw SetText: Difference between revisions

From MultiCharts
No edit summary
No edit summary
Line 5: Line 5:


Where: ObjectID - a numerical expression specifying the object ID number  
Where: ObjectID - a numerical expression specifying the object ID number  
            <syntaxhighlight>Text</syntaxhighlight> - the string expression to be displayed in the arrow object  
 
[[Text]] - the string expression to be displayed in the arrow object  


==== Notes ====  
==== Notes ====  
An object-specific ID number is returned by <syntaxhighlight>Arw_New</syntaxhighlight> when the arrow object is created.  
An object-specific ID number is returned by [[Arw_New]] when the arrow object is created.  
   
   
==== Example ====
==== Example ====

Revision as of 13:23, 20 January 2012

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 - the string expression to be displayed in the arrow object

Notes

An object-specific ID number is returned by 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");