Use Alarm Tree Viewer control ActiveX properties
- Last UpdatedJul 19, 2024
- 2 minute read
You can set the value an Alarm Tree Viewer control property directly using a script or you can assign it to an InTouch tag or I/O reference. For more information about setting properties, see Scripting ActiveX Controls.
The following table lists all Alarm Tree Viewer control properties. For more information on setting color values, see Configure colors for ActiveX Controls.
|
Property Name |
Purpose |
|---|---|
|
AddtoFavoritesMenu |
Enables or disables the Add to Favorites shortcut menu command. |
|
AlarmQuery |
Shows the initial alarm query and allows you to change the query. The valid syntax is \\<node>\<provider> or \<provider>. |
|
ElementSelection |
Controls whether an element in the tree can be selected or not by the operator during run time. |
|
ExpansionLevel |
Sets the branch level to which the alarm tree is opened when you manually refresh the control. A value of 1 shows only the provider, a value of 2 shows the direct alarm groups of the provider, and so on. |
|
Font |
Gets or sets the font of records and headings shown in the control. |
|
FreezeMenu |
Enables or disables the Freeze menu command. |
|
HeaderText |
Gets or sets the text that appears in the header of the Alarm Tree Viewer control. |
|
MultiSelection |
Allows you to select multiple elements in the Alarm Tree Viewer control. |
|
QueryFavoritesFile |
Gets or sets the query favorites file name. |
|
QueryFavoritesMenu |
Enables or disables the Query Favorites menu command. |
|
QueryStartup |
Automatically updates the Alarm Tree Viewer control using default query properties if selected. If not selected, you must requery to update the Alarm Tree Viewer control. |
|
RefreshInterval |
Gets the auto refresh interval of the control in seconds. |
|
RefreshMenu |
Gets or sets a value that determines whether the Refresh command appears in the shortcut menu. |
|
SelTextBackColor |
Gets or sets the background color for the selected element. |
|
SelTextColor |
Gets or sets the text color for the selected element. |
|
ShowContextMenu |
Enables or disables the shortcut menu. |
|
ShowHeading |
Shows or hides the title bar of the Alarm Tree Viewer control. |
|
ShowStatusBar |
Gets or sets a value that determines whether the status bar is shown. |
|
SilentMode |
Gets or sets a value that determines whether the control is in Silent mode. |
|
SortElements |
Enables or disables sorting in the Alarm Tree Viewer control. |
|
SortMenu |
Enables or disables the Sort menu command. |
|
SortOrder |
Gets or sets the sort direction. Possible values are "Ascending" and "Descending," represented as 0 and 1 respectively. |
|
StatsMenu |
Enables or disables the Statistics menu command. |
|
TextColor |
Gets or sets the text color the Alarm Tree Viewer control. |
|
TitleBackColor |
Gets or sets the title bar background color. Available only if the ShowHeading property is set. |
|
TitleForeColor |
Gets or sets the title bar foreground color. Available only if the ShowHeading property is set. |
|
WindowColor |
Gets or sets the window background color of the Alarm Tree Viewer control. |