OBJECT Get indicator type
OBJECT Get indicator type ( {* ;} object ) -> Function result
| Parameter | Type | Description | |
|---|---|---|---|
| * | Operator | → | If specified, object is an object name (string) If omitted, object is a variable |
| object | any | → | Object name (if * is specified) or Variable (if * is omitted) |
| Function result | Longint | ← | Indicator type |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The OBJECT Get indicator type command returns the current indicator type assigned to the thermometer(s) designated by the object and * parameters.
You can set the indicator type using the Property List in Design mode, or using the OBJECT SET INDICATOR TYPE 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).
You can compare the value returned by the command with the following constants, found in the "Form Objects (Properties)" theme:
| Constant | Type | Value | Comment |
|---|---|---|---|
| Asynchronous progress bar | Longint | 3 | Circular indicator displaying continuous animation |
| Barber shop | Longint | 2 | Bar displaying continuous animation |
| Progress bar | Longint | 1 | Standard progress bar |