Text SetSize: Difference between revisions
From MultiCharts
(Created page with "Assigns the specified font size to the text of a text object with the specified ID number; returns a value of 0 if the font size was successfully assigned, and a value of -2 i...") |
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: | ||
Assigns the specified font size to the text of a text object with the specified ID number | Assigns the specified font size to the text of a text object with the specified ID number. | ||
Text_SetSize returns a value of 0 if the font size was successfully assigned, and a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Text_SetSize(ObjectID,FontSize)</syntaxhighlight> | <syntaxhighlight>Text_SetSize(ObjectID, FontSize)</syntaxhighlight> | ||
Where: | Where: | ||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
:'''FontSize''' - a numerical expression specifying the font size. | |||
== 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. | ||
* Use [[Text_GetSize]] to get the size of the text object's font. | |||
== Example == | |||
Assign the font size of 16 to the text of a text object with the ID number of 3: | Assign the font size of 16 to the text of a text object with the ID number of 3: | ||
<syntaxhighlight>Value1=Text_SetSize(3,16);</syntaxhighlight> | <syntaxhighlight>Value1=Text_SetSize(3, 16);</syntaxhighlight> | ||
[[Category:Text Drawing]] | [[Category:Text Drawing]] | ||
Latest revision as of 13:07, 13 February 2012
Assigns the specified font size to the text of a text object with the specified ID number.
Text_SetSize returns a value of 0 if the font size was successfully assigned, and a value of -2 if the specified object ID number is invalid.
Usage
Text_SetSize(ObjectID, FontSize)Where:
- ObjectID - a numerical expression specifying the object ID number.
- FontSize - a numerical expression specifying the font size.
Notes
- An object-specific ID number is returned by Text_New when the text object is created.
- Use Text_GetSize to get the size of the text object's font.
Example
Assign the font size of 16 to the text of a text object with the ID number of 3:
Value1=Text_SetSize(3, 16);