Difference between revisions of "Text Delete"
Jump to navigation
Jump to search
(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...") |
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
||
(3 intermediate revisions by 2 users not shown) | |||
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]] |
Latest revision as of 13:12, 13 February 2012
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
Text_Delete(ObjectID)
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.
Example
Remove the text object with an ID number of 3:
Value1 = Text_Delete(3);