Text Delete: Difference between revisions
From MultiCharts
no edit summary
(Created page with "Removes a text object with the specified ID number from a chart; returns a value of 0 if the object was successfully removed, and a value of -2 if the specified object ID numb...") |
No edit summary |
||
Line 1: | Line 1: | ||
Removes a text object with the specified ID number from a chart | Removes a text object with the specified ID number from a chart. | ||
Text_Delete returns a value of 0 if the object was successfully removed and a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Text_Delete(ObjectID)</syntaxhighlight> | <syntaxhighlight>Text_Delete(ObjectID)</syntaxhighlight> | ||
Where: | Where: | ||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
== Notes == | |||
An object-specific ID number is returned by [[Text_New]] when the text object is created. | An object-specific ID number is returned by [[Text_New]] when the text object is created. | ||
== Example == | |||
Remove the text object with an ID number of 3: | Remove the text object with an ID number of 3: | ||
<syntaxhighlight>Value1=Text_Delete(3);</syntaxhighlight> | <syntaxhighlight>Value1 = Text_Delete(3);</syntaxhighlight> | ||
[[Category:Text Drawing]] | [[Category:Text Drawing]] |