Scripting Guide - AlarmBanner.SelectedAlarms (Alarm Banner Functions and Properties)

AlarmBanner.SelectedAlarms

The AlarmBanner.SelectedAlarms property represents a collection of the alarms that are currently selected in the Alarm Banner. It is only available for the Alarm Banner object and so only applies to Alarm Banner scripts.

Syntax	AlarmBanner.SelectedAlarms
Description	Represents the alarms that are currently selected in the Alarm Banner in ViewX.
Arguments	None.
Returns	Alarm Collection. A collection of alarms (the alarms selected in the Alarm Banner). You can then access the properties of individual alarms in the collection (see Alarm Collection Properties).

Example:

In this example, the function AllAlarms calls the ReassignAlarm function for the currently selected alarms in the Alarm Banner. The ReassignAlarm function would be defined elsewhere in the script and would define the user to which the alarms are to be reassigned.

Function AllAlarm
- for each A in AlarmBanner.SelectedAlarms
  - ReassignAlarm A
- Next
End Function

The letter A represents each alarm in the collection. A is simply a variable and you can use any letter or word to represent each alarm.