Difference between revisions of "Text SetBorder"
Jump to navigation
Jump to search
(Created page with "Adds or removes a border around the text object with the specified ID number; returns a value of 0 if the border was successfully set, and a value of -2 if the specified objec...") |
|||
| Line 1: | Line 1: | ||
| − | Adds or removes a border around the text object with the specified ID number | + | Adds or removes a border around the text object with the specified ID number. |
| + | |||
| + | Text_SetBorder returns a value of 0 if the border was successfully set, and a value of -2 if the specified object ID number is invalid. | ||
The color of the border is the same as the color of the text in the text object. | The color of the border is the same as the color of the text in the text object. | ||
| − | + | == Usage == | |
| − | <syntaxhighlight>Text_SetBorder(ObjectID,LogicalExpression)</syntaxhighlight> | + | <syntaxhighlight>Text_SetBorder(ObjectID, LogicalExpression)</syntaxhighlight> |
| + | |||
| + | Where: | ||
| − | + | :'''ObjectID''' - a numerical expression specifying the object ID number. | |
| − | + | :'''LogicalExpression''' - a logical value; True = Add and False = Remove. | |
| − | + | == 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 == | |
Add a border to the text object with an ID number of 3: | Add a border to the text object with an ID number of 3: | ||
| − | <syntaxhighlight>Value1=Text_SetBorder(3,True);</syntaxhighlight> | + | <syntaxhighlight>Value1 = Text_SetBorder(3, True);</syntaxhighlight> |
Remove a border from the text object with an ID number of 3: | Remove a border from the text object with an ID number of 3: | ||
| − | <syntaxhighlight>Value1=Text_SetBorder(3,False);</syntaxhighlight> | + | <syntaxhighlight>Value1 = Text_SetBorder(3, False);</syntaxhighlight> |
| − | |||
| − | |||
[[Category:Text Drawing]] | [[Category:Text Drawing]] | ||
Revision as of 08:46, 9 February 2012
Adds or removes a border around the text object with the specified ID number.
Text_SetBorder returns a value of 0 if the border was successfully set, and a value of -2 if the specified object ID number is invalid.
The color of the border is the same as the color of the text in the text object.
Usage
Text_SetBorder(ObjectID, LogicalExpression)
Where:
- ObjectID - a numerical expression specifying the object ID number.
- LogicalExpression - a logical value; True = Add and False = Remove.
Notes
- An object-specific ID number is returned by Text_New when the text object is created.
Example
Add a border to the text object with an ID number of 3:
Value1 = Text_SetBorder(3, True);
Remove a border from the text object with an ID number of 3:
Value1 = Text_SetBorder(3, False);
