Text GetBorder: Difference between revisions
From MultiCharts
(→Usage) |
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
||
| Line 3: | Line 3: | ||
Text_GetBorder returns a value of '''True''' if the border has been added and a value of '''False''' if the border has not been added or if the specified object ID number is invalid. | Text_GetBorder returns a value of '''True''' if the border has been added and a value of '''False''' if the border has not been added or if the specified object ID number is invalid. | ||
== Usage == | |||
<syntaxhighlight>Text_GetBorder(ObjectID)</syntaxhighlight> | |||
Where: | |||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
== Notes == | == 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. | ||
Latest revision as of 13:07, 13 February 2012
Returns a logical value, indicating whether a border is added to a text object with the specified ID number.
Text_GetBorder returns a value of True if the border has been added and a value of False if the border has not been added or if the specified object ID number is invalid.
Usage
Text_GetBorder(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.
- Use Text_SetBorder to set the border for a text object.
Example
Assign a true/false value, indicating whether a border is added to the text object with an ID number of 3, to Border variable:
Variable: Border(False);
Border = Text_GetBorder(3);