Difference between revisions of "Text GetSize"
Jump to navigation
Jump to search
(Created page with "Returns a numerical value indicating the font size assigned to a text object with the specified ID number; returns a value of -2 if the specified object ID number is invalid. ...") |
|||
| Line 1: | Line 1: | ||
| − | Returns a numerical value indicating the font size assigned to a text object with the specified ID number | + | Returns a numerical value indicating the font size assigned to a text object with the specified ID number. |
| − | + | Text_GetSize returns a value of -2 if the specified object ID number is invalid. | |
| + | |||
| + | == Usage == | ||
<syntaxhighlight>Text_GetSize(ObjectID)</syntaxhighlight> | <syntaxhighlight>Text_GetSize(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 == | |
Assign a value, indicating the font size of the text object with an ID number of 3, to Value1 variable: | Assign a value, indicating the font size of the text object with an ID number of 3, to Value1 variable: | ||
| − | <syntaxhighlight>Value1=Text_GetSize(3);</syntaxhighlight> | + | <syntaxhighlight>Value1 = Text_GetSize(3);</syntaxhighlight> |
[[Category:Text Drawing]] | [[Category:Text Drawing]] | ||
Revision as of 08:30, 9 February 2012
Returns a numerical value indicating the font size assigned to a text object with the specified ID number.
Text_GetSize returns a value of -2 if the specified object ID number is invalid.
Usage
Text_GetSize(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
Assign a value, indicating the font size of the text object with an ID number of 3, to Value1 variable:
Value1 = Text_GetSize(3);
