AlarmListChanged Event

Occurs when the contents or order of information in the Alarm Summary object changes. By default, this event does not fire. To trigger the event when information in the Alarm Summary object changes, set the CheckForAlarmListChanged property to TRUE.

Syntax

object_AlarmListChanged()

Properties

The AlarmListChanged event syntax has this part:

Part

Description

object

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

Remarks

This event occurs on the initial receipt of alarms by the Alarm Summary object. The event occurs subsequently whenever the contents or order of alarms displayed by the Alarm Summary object changes. For example, the event may also occur when you change the alarm filter if the modified filter changes the content of the object's spreadsheet (for example, if it filters out alarms or adds alarms from another alarm area). The event occurs even if the change in content happens off screen. The following actions may also cause the AlarmListChanged event to fire but only if the action changes the content of the object's spreadsheet:

  • Changing the sort order.
  • Detecting/receiving a new alarm.

You can disable the AlarmListChanged event by setting the CheckForAlarmListChanged property to FALSE.

 

Applies To