Difference between revisions of "Text GetBorder"
Jump to navigation
Jump to search
(Created page with "Returns a logical value, indicating whether a border is added to a text object with the specified ID number; returns a value of True if the border has been added, and a va...") |
|||
| Line 1: | Line 1: | ||
| − | Returns a logical value, indicating whether a border is added to a text object with the specified ID number | + | 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 == | |
<syntaxhighlight>Text_GetBorder(ObjectID)</syntaxhighlight> | <syntaxhighlight>Text_GetBorder(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 true/false value, indicating whether a border is added to the text object with an ID number of 3, to Border variable: | Assign a true/false value, indicating whether a border is added to the text object with an ID number of 3, to Border variable: | ||
| − | <syntaxhighlight>Variable:Border(False); | + | <syntaxhighlight>Variable: Border(False); |
| − | Border=Text_GetBorder(3);</syntaxhighlight> | + | Border = Text_GetBorder(3);</syntaxhighlight> |
[[Category:Text Drawing]] | [[Category:Text Drawing]] | ||
Revision as of 08:01, 9 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.
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);
