Difference between revisions of "Text SetBorder"
Jump to navigation
Jump to search
(→Usage) |
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
||
(One intermediate revision by one other user not shown) | |||
Line 5: | Line 5: | ||
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> | ||
+ | Where: | ||
+ | |||
+ | :'''ObjectID''' - a numerical expression specifying the object ID number. | ||
+ | |||
+ | :'''LogicalExpression''' - a logical value; True = Add and False = Remove. | ||
+ | |||
== 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 12:39, 13 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.
- Use Text_GetBorder to get the border properties from a specific text object.
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);