GetAlarmBackgroundColor Method

Returns the row background color configured for the specified alarm priority.

Syntax

object.GetAlarmBackgroundColor(PriorityId)

Properties

The GetAlarmBackgroundColor method syntax has these parts:

Part

Description

object

An object expression that evaluates to an object in the Applies To list.

PriorityId

Integer. The ID corresponding to the alarm priority.

Valid entries for iFIX 3.5 and earlier:
0 - High
1 - Medium
2 - Low

Valid entries for iFIX 4.0 and later:
3 - CRITICAL
4 - HIHI
5 - HIGH
6 - MEDIUM
7 - LOW
8 - LOLO
9 - INFO  (INFORMATIONAL)

Return Value

OLE_COLOR. The row background color configured for the specified alarm priority.

 

Example

Applies To