Difference between revisions of "Arw SetText"
Jump to navigation
Jump to search
(→Usage) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | Adds text to, or replaces the existing text contained in an arrow object with the specified ID number | + | 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 == | |
| + | <syntaxhighlight>Arw_SetText(ObjectID, "Text")</syntaxhighlight> | ||
| + | |||
| + | 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 | + | * An object-specific ID number is assigned by [[Arw_New]], [[Arw_New_s]], [[Arw_New_self]] or [[Arw_New_self_s]] when the arrow object is created. |
| + | * Use [[Arw_GetActive]], [[Arw_GetFirst]] or [[Arw_GetNext]] to get the object-specific ID number of an already created arrow. | ||
| − | == | + | == Examples == |
Add text "My Arrow" to the arrow object with an ID number of 3: | Add text "My Arrow" to the arrow object with an ID number of 3: | ||
| − | <syntaxhighlight>Value1=Arw_SetText(3,"My Arrow");</syntaxhighlight> | + | <syntaxhighlight>Value1 = Arw_SetText(3, "My Arrow");</syntaxhighlight> |
Replace text contained in the arrow object with an ID number of 3 with the string expression "New Text": | Replace text contained in the arrow object with an ID number of 3 with the string expression "New Text": | ||
| − | <syntaxhighlight>Value1=Arw_SetText(3,"New Text");</syntaxhighlight> | + | <syntaxhighlight>Value1 = Arw_SetText(3, "New Text");</syntaxhighlight> |
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Latest revision as of 09:24, 19 February 2012
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
- An object-specific ID number is assigned by Arw_New, Arw_New_s, Arw_New_self or Arw_New_self_s when the arrow object is created.
- Use Arw_GetActive, Arw_GetFirst or Arw_GetNext to get the object-specific ID number of an already created arrow.
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");
