Difference between revisions of "Text SetString"
Jump to navigation
Jump to search
(Created page with "Replaces with the specified string expression the text contained in a text object with the specified ID number; returns a value of 0 if the string expression was successfully ...") |
|||
| Line 1: | Line 1: | ||
| − | Replaces with the specified string expression the text contained in a text object with the specified ID number | + | Replaces with the specified string expression the text contained in a text object with the specified ID number. |
| + | |||
| + | Text_SetString returns a value of 0 if the string expression was successfully replaced and a value of -2 if the specified object ID number is invalid. | ||
| − | + | == Usage == | |
| − | <syntaxhighlight>Text_SetString(ObjectID,"Text")</syntaxhighlight> | + | <syntaxhighlight>Text_SetString(ObjectID, "Text")</syntaxhighlight> |
| + | |||
| + | Where: | ||
| − | + | :'''ObjectID''' - a numerical expression specifying the object ID number. | |
| − | + | :'''Text''' - the new string expression to be displayed in the text object. | |
| − | + | == 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 == | |
Replace the text, contained in a text object with the ID number of 3, with the string expression "New Text": | Replace the text, contained in a text object with the ID number of 3, with the string expression "New Text": | ||
| − | <syntaxhighlight>Value1=Text_SetString(3,"New Text");</syntaxhighlight> | + | <syntaxhighlight>Value1 = Text_SetString(3, "New Text");</syntaxhighlight> |
[[Category:Text Drawing]] | [[Category:Text Drawing]] | ||
Revision as of 08:36, 9 February 2012
Replaces with the specified string expression the text contained in a text object with the specified ID number.
Text_SetString returns a value of 0 if the string expression was successfully replaced and a value of -2 if the specified object ID number is invalid.
Usage
Text_SetString(ObjectID, "Text")
Where:
- ObjectID - a numerical expression specifying the object ID number.
- Text - the new string expression to be displayed in the text object.
Notes
An object-specific ID number is returned by Text_New when the text object is created.
Example
Replace the text, contained in a text object with the ID number of 3, with the string expression "New Text":
Value1 = Text_SetString(3, "New Text");
