Use Alarm Viewer control ActiveX properties

AckAllMenu

Discrete

Enables/disables Ack All menu item.

AckAlmColorRange1

Integer

Sets color to be used to show acknowledged alarms with priorities in the range 1 to ColorPriorityRange1. The default priority range is 1 to 250.

AckAlmColorRange2

Integer

Sets color to be used to acknowledged alarms with priorities in the range ColorPriorityRange1 to ColorPriorityRange2. The default priority range is 250 to 500.

AckAlmColorRange3

Integer

Sets color to be used to acknowledged alarms with priorities in the range ColorPriorityRange2 to ColorPriorityRange3. The default priority range is 500 to 750.

AckAlmColorRange4

Integer

Sets color to be used to acknowledged alarms with priorities in ColorPriorityRange3 to 999. The default priority range is 750 to 999.

AckOthersMenu

Discrete

Enables/disables Ack Others menu item.

AckSelectedGroupsMenu

Discrete

Enables/disables Ack Selected Groups menu item.

AckSelectedMenu

Discrete

Enables/disables Ack Selected menu item.

AckSelectedPrioritiesMenu

Discrete

Enables/disables Ack Selected Priorities menu item.

AckSelectedTagsMenu

Discrete

Enables/disables Ack Selected Tags menu item.

AckVisibleMenu

Discrete

Enables/disables Ack Visible menu item.

AlarmQuery

Message

Sets the initial alarm query. This field accepts text only; it does not accept tags.
The following example uses the full path to the alarm group:

\\Node\InTouch!Group

This example uses the full path to the local alarm group:

\InTouch!Group

This example uses another Group List:

GroupList

AlarmState

Message

Default alarm state to query (All, UnAck, Ack).

AlmRtnColor

Integer

Sets the color for alarms that have returned to normal and were unacknowledged. This color is also used for alarms that returned to normal from the acknowledged state but the acknowledgement state transition was not observed.

AutoScroll

Discrete

If the user scrolls the list from the beginning, this automatically jumps to the new alarm. New alarms are defined as those that are not currently shown within the display object.

ColorPriorityRange1

Integer

Sets the boundary of the priority range in which alarms are to be shown. The value of this property must be greater than one and less than the value for ColorPriorityRange2.

ColorPriorityRange2

Integer

Sets the boundary of the priority range in which alarms are to be shown. The value of this property must be greater than the value for ColorPriorityRange1 and less than the value for ColorPriorityRange3.

ColorPriorityRange3

Integer

Sets the boundary of the priority range in which alarms are to be shown. The value of this property must be greater than the value of ColorPriorityRange2 and less than 999.

ColumnResize

Discrete

Returns or sets a value that determines whether the columns can be resized at run time.

CustomMessage

Message

The default message to show when there are no alarms.

DefaultAckComment

Message

Used as a comment when the alarm is acknowledged and when the "UseDefaultAckComment" is TRUE. Otherwise, the user is prompted to enter a comment.

DisplayedTime

Message

Shows the alarm message time. The values can only be "OAT" or "LCT" or "LCT But OAT on ACK."

DisplayedTimeZone

Message

Gets or sets the current time zone string.
The values can only be "GMT" or "Origin Time" or "Local Time."

EventColor

Integer

Sets color of events.

ExtendedSelection

Discrete

Allows you to select multiple alarms by holding down the Ctrl or Shift key in conjunction with the mouse button.
The default is to toggle selection of alarms by simply selecting on them (available only if the Row Selection check box is selected).

FlashUnAckAlarms

Discrete

Enables or disables the flashing of unacknowledged alarms. It takes a discrete input value of 1 or 0. If this property is set to 1, unacknowledged alarms flash once per second. If this property is set to 0, unacknowledged alarms do not flash.
This property corresponds to the Flash Unack Alarms check box on the Alarm Viewer control General tab.

FlashUnackAlmColorRange1

Integer

Sets the flashing color for unacknowledged alarms belonging to Alarm Priority Range 1.

FlashUnackAlmColorRange2

Integer

Sets the flashing color for unacknowledged alarms belonging to Alarm Priority Range 2.

FlashUnackAlmColorRange3

Integer

Sets the flashing color for unacknowledged alarms belonging to Alarm Priority Range 3.

FlashUnackAlmColorRange4

Integer

Sets the flashing color for unacknowledged alarms belonging to Alarm Priority Range 4.

Font

None

Sets the font for the records and the header in the control.

FreezeMenu

Discrete

Enables/disables the Freeze menu item.

FromPriority

Integer

Sets the low priority value of the default query.

GridColor

Integer

Sets the color of the background grid.

NewAlarmEventMode

Integer

Controls the triggering of the NewAlarm event.

0 = The NewAlarm event can not be triggered. (Default).

1 = The NewAlarm event is active.

2 = The NewAlarm event is active and continually triggers when at least one new unacknowledged alarm arrives.

QueryFavoritesFile

Message

Returns or sets the query favorites file name.

QueryFavoritesMenu

Discrete

Enables/disables the Query Favorites menu item.

QueryName

String

Returns the current query name.

QueryStartup

Discrete

Automatically begins updating the grid using default query properties, if set.
Otherwise, you must run the ApplyDefaultQuery or ApplyQuery method in a script to update the grid.

QueryType

Message

Sets the display type as either Summary or Historical.

RequeryMenu

Discrete

Enables/disables Requery shortcut menu item.

RetainSuppression

Discrete

Retains alarm suppression between alarm queries when the alarm query is changed.

RowSelection

Discrete

Allows user to select alarms during run time.

SecondarySortColumn

Message

Returns or sets the current secondary sort column.

SelectedCount

Integer

Returns the total number of selected alarms.

ShowContextMenu

Discrete

Enables the activation of the shortcut menu.

ShowGrid

Discrete

Returns or sets a value that determines whether the grid lines are shown in the control.

ShowHeading

Discrete

Shows the title bar of the control.

ShowMessage

Discrete

Returns or sets a value that determines whether error messages are shown for the control.

ShowStatusBar

Discrete

Gets or sets a value that determines whether the status bar is shown.

SilentMode

Discrete

Gets or sets a value that determines whether the control is in silent mode.

SortColumn

Message

Gets or sets the current sort column.

SortMenu

Discrete

Enables/disables the Sort menu item.

SortOrder

Discrete

Gets or sets the sort direction. Possible values are "Ascending" and "Descending," represented as 0 and 1 respectively.

StatsMenu

Discrete

Enables/disables the Stats menu item.

SuppressAllMenu

Discrete

Enables/disables the Suppress All menu item.

SuppressedAlarms

Integer

Gets the total number of suppressed alarms.

SuppressionMenu

Discrete

Enables/disables the Suppression menu item.

SuppressOthersMenu

Discrete

Enables/disables the Suppress Others menu item.

SuppressSelectedGroupsMenu

Discrete

Enables/disables the Suppress Selected Groups menu item.

SuppressSelectedMenu

Discrete

Enables/disables the Suppress Selected menu item.

SuppressSelectedPrioritiesMenu

Discrete

Enables/disables the Suppress Selected Priorities menu item.

SuppressSelectedTagsMenu

Discrete

Enables/disables Suppress Selected Tags menu item.

SuppressVisibleMenu

Discrete

Enables/disables the Suppress Visible menu item.

TimeFormat

Message

Sets the format of the alarm time stamps.

TitleBackColor

Integer

Sets title bar background color.

TitleForeColor

Integer

Sets title bar foreground color.

ToPriority

Integer

Sets the maximum priority for the alarm query.

TotalAlarms

Integer

Gets the number of alarms.

UnackAlarms

Integer

Gets the total number of unacknowledged alarms.

UnAckAlmColorRange1

Integer

Sets the color to be used to show unacknowledged alarms with priorities in the range of 1 to ColorPriorityRange1.

UnAckAlmColorRange2

Integer

Sets the color to be used to show unacknowledged alarms with priorities in the range of ColorPriorityRange1 to ColorPriorityRange2.

UnAckAlmColorRange3

Integer

Sets the color to be used to show unacknowledged alarms with priorities in the range of ColorPriorityRange2 to ColorPriorityRange3.

UnAckAlmColorRange4

Integer

Sets the color to be used to show unacknowledged alarms with priorities in the range of ColorPriorityRange3 to 999.

UnsuppressAllMenu

Discrete

Enables/disables Unsuppress All menu item.

UseDefaultAckComment

Discrete

If set to True, the default acknowledgement comment is used when the alarm is acknowledged. Otherwise, the operator is prompted to enter a comment.

WindowColor

Integer

Sets the grid background color.