Defines an object that configures the colors of an active Alarm. This property is indexed by the Alarm severity and is only available via script. The next table contains all possible values for the index of this property.
Available options for the index of the ColorActiveAlarm property
Index |
Severity |
Returned Object |
|---|---|---|
-2 |
Critical |
Defines the colors for active Alarms with a critical severity |
-1 |
- |
Defines the colors for active Alarms, regardless of their severity |
0 |
High |
Defines the colors for active Alarms with a high severity |
1 |
Medium |
Defines the colors for active Alarms with a medium severity |
2 |
Low |
Defines the colors for active Alarms with a low severity |
The next code contains an example of using this property.
' Returns an object to configure the colors of active Alarms with high severity
Set AlarmObject = Screen.Item("E3Alarm1").ColorActiveAlarm(0)
' Copies the configuration of the active Alarm with high severity (0)
' to the active Alarm with medium severity (1)
Screen.Item("E3Alarm1").ColorActiveAlarm(1) = Screen.Item("E3Alarm1").ColorActiveAlarm(0)
The object returned by this property represents an active Alarm in a specific severity, that is, critical, high, medium, low, or the default configuration of this type of Alarm. By using this object, users can configure an Alarm's background color, text color, and its blinking mode, which are also available for configuration on the Properties Window of the E3Alarm object, on the Colors tab. For more information about the object returned by this property, please check topic Alarm Color.