Displaying an Alarm List – DrawList Module

The DrawList module enables you to display an alarm list. DrawList takes the following parameters:

\AlarmPanel\DrawList(Name, LineFormat, StartList, ListFont, BackgroundColor)

Name is the name of the variable that will hold panel information. If this variable does not exist, it will be created. When drawing alarm panel objects online, the DrawList should be displayed first so that the name variable is created when other draw objects requiring it are drawn.

LineFormat is an integer value that determines format for the line to be displayed on the screen. The formats are:

0:       Custom alarm line format

1:       Event/status, Priority, Time, Date, Area, Message (Tag Description or Name if no Description is specified), and operator.

2:       Time, Date, and Message

StartList is the initial list to display. The options are:

-2:      Current alarms list (merged active and unacknowledged lists)

-1:      All registered alarms list

0:       Log or "history" list

1:       Disabled alarms list

2:       Active alarms list

3:       Unacknowledged alarms list

4+:     User-defined alarms list

ListFont is the font to use to draw the alarm list items.

BackgroundColor is the color to use for the background of the alarm list (see Reserved Color Values).

Note: VTS includes a built-in tool for drawing a button to acknowledge all unacknowledged alarms without requiring you to alter any code. Information on the Alarm Tools library can be found in "VTS Developer's Guide: Alarm Tools Library". Information specific to the Alarm List tool that enables you to draw such a button on a application page can be found in "VTS Developer's Guide: Ack All Button Alarm Library Tool".