OBJECT Get border style
OBJECT Get border style ( {* ;} object ) : Integer
| Parameter | Type | Description | |
|---|---|---|---|
| * | Operator | → | If specified, object is an object name (string) If omitted, object is a field or variable |
| object | any | → | Object name (if * is specified) or Field or variable (if * is omitted) |
| Function result | Integer | ← | Border line style |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The OBJECT Get border style command returns the border line style of the object(s) designated by the object and * parameters.
You can set the border line style for an object in Design mode using the Property List, or using the OBJECT SET BORDER STYLE command.
Passing the optional * parameter indicates that the object parameter is an object name (string). If you do not pass this parameter, it indicates that the object parameter is a field or variable. In this case, you pass a field or variable reference instead of a string (field or variable object only).
The command returns a value corresponding to the border line style. You can compare the value received with the following constants, found in the "Form Objects (Properties)" theme:
| Constant | Type | Value | Comment |
|---|---|---|---|
| Border Dotted | Integer | 2 | Objects appear framed with a dotted 1-pt. border line |
| Border Double | Integer | 5 | Objects appear framed with a double line, i.e., two continuous 1-pt. lines separated by a pixel |
| Border None | Integer | 0 | Objects appear with no border |
| Border Plain | Integer | 1 | Objects appear framed with a continuous 1-pt. border line |
| Border Raised | Integer | 3 | Objects appear framed with a 3D effect (raised) |
| Border Sunken | Integer | 4 | Objects appear framed with a sunken 3D effect |
| Border System | Integer | 6 | The border line is drawn based on the graphic specifications of the system |