The Alarm Grid has numerous properties available for configuration in the Properties pane. The following topic describes a basic workflow for configuring this control. The specific appearance and functionality of the object you create depends on your needs and implementation of the control's properties, each of which is described below.
Use the Settings pane to apply common settings (sizing, grouping, alignment, etc.) to this object (and others) on your screen.
The Style property defines the style sheet applied to an object on a screen. A style sheet consists of a predetermined list of properties and property values configured for a particular control type.
Styles are created in two ways:
Tip: You can also change a control's Style on the Controls view of the Screen pane.
The Include in script check box indicates that the control will appear in the objects collection of the screen (if scripting is enabled). To optimize performance, best practice dictates that you only include the controls you need to manipulate via script. Other controls should be excluded. When you add an event to a control, it will be automatically added to script and the Include in script property (and the In Script check box on the Controls view) will be set to True.
Tip: You can also change the Include in Script setting on the Controls view of the Screen pane.
The Color configuration property is a control-level property that governs all color settings for the columns in the Alarm grid. Click
to reveal a set of color options where you can specify the source of the color to be used for the background, text, border, and the alarm acknowledgment options for all columns. The Color configuration box consists of the following options, which are described below:
The Display alarm acknowledgment property enables the cell or text tool's background, text, and border to blink when the associated point is in alarm. Check each box to configure the:
If none of these options are selected, no visual indication of a point in alarm will be presented. However, if the point is in alarm, an Acknowledge alarm option will be available from the context menu in run mode.
The Grid Column Configuration dialog box contains all properties required to configure columns in your grid. There are five types of columns that can be configured in an alarm grid: an Alarm icon column (configured separately), an Alarm column, a Facility column, a Generic column, and a Point column. The number of defined columns is listed on the property label once defined.
You can create your own columns or select from 11 default columns: four Alarm columns (Alarm Priority, Alarm Acknowledge, Primary Value, Timestamp), and seven Point columns (Alarm Condition, SiteService, Long Point ID, Primary Units, Description, Facility ID, Uniform Data Code).
Notes:
The Facility sender mode property determines which mouse-click actions will send facilities to other controls. Options include:
The default value is None.
Some controls on the same screen allow for the sending of facility tag information from one control to another.
The grid controls offer three selection modes, which determine how many grid units may be selected in run mode. The grid units are determined by the Selection unit property. Options include:
The default value is Single.
In script, use SelectionMode with the SelectAll method and SelectedRows property (read-only) to aid in multi-row selection:
The Height property specifies the height of the control (or screen).
Tip: You can also change the height of a control using the Settings pane (click on the
(Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
The Horizontal resize mode property specifies whether and how the control dynamically moves or resizes horizontally when the screen is resized in run mode. Options include:
The default value is None.
The Layer property specifies the layer for this control. Layers are used to show, hide, and edit multiple controls on one layer without affecting controls on another layer.
Tip: You can also edit a control's Layer on the Controls view of the Screen pane.
The Vertical resize mode property specifies whether and how the control dynamically moves or resizes vertically when the screen is resized in run mode. Options include:
The default value is None.
The Width property specifies the width of the control (or screen).
Tip: You can also change the width of a control using the Settings pane (click on the
(Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
The X property specifies the location of the control along the horizontal axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels.
Tip: You can also change the location of the control using the Settings pane; click on the
(Settings) to the right of the control in design mode.
The Y property specifies the location of the control along the vertical axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels.
Tip: You can also change the location of the control using the Settings pane; click on the
(Settings) to the right of the control in design mode.
The Z index property is used to determine the order in which controls are layered on top of each other. Controls with higher values will draw on top of those with lower values. The newest control added to a screen will always have the highest value and will be the top layer. Two or more controls can be on the same index (layer).
Tip: You can also change the Z index of a control using the Settings pane (click on the
(Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
The Alarm icon column property is used to indicate whether a column and icon will be displayed as the first column of the alarm grid. A customizable icon can be configured to change color based on point state and change image based on alarm priority. Icons will display only when there is an unacknowledged alarm. Click
to configure the column, the icon color source, the associated priority ranges, and the icon image used for each priority in the Alarm Priority Icon Ranges dialog box.
To create a customized alarm
alarm-highlight" to the XML class defining the element of your custom icon that you want to have filled using the color specified in the Icon color source from above. For example, <circle id="Alarm" class="st2 alarm-highlight" cx="8" cy="8" r="5.5"/>Note: You can override the default point state colors for this element by creating a custom color palette. See Configuring Color Palettes and Color palette for a screen or object for more information.
CygNet Help:
For more information about alarm priority, see the Alarm Priority, Alarm Priority Category, and Alarm Category topic in the CygNet Help:
For more information about point state attributes, see the Point State Definitions topic in the CygNet Help:
An alarm column presents data for a point by an alarm attribute. The property sheet displays Common and Alarm properties.
The Sort numerically property specifies whether this column can be sorted numerically. In run mode, clicking a column header moves between the three states: sort ascending, sort descending, and unsorted. A small arrow indicates the sort order.
Note: Any column with mixed string and numeric data (like the Value column of the Alarm Grid) will be sorted as a string.
The Alarm attribute property specifies the alarm attribute that will be displayed in the column. Click
to reveal a drop-down menu of available CygNet alarm attributes supported by the alarm grid:
The Date and time format property specifies the format for a point's timestamp using any of the valid .NET standard or custom numeric format strings. The date and time format applies to a point's Timestamp, Last Verified Change Timestamp, and Last Questionable Change Timestamp properties. Use this property to override the default format, which is configured on the Settings page of the Backstage view. The default format is YYYY/MM/DD HH:MM:SS.fff, which corresponds to 2019/01/01 10:20:30.0001. All timestamps are local client time.
Note: You can also use the Microsoft .NET Standard Date and Time Format Strings to define the text representation of a date and time value in Canvas. For example, "d" is the short date pattern and corresponds to 1/1/2019, "F" is the full date/time pattern and corresponds to Monday, January 1, 2019 1:45:30 PM.
A facility column presents data for a point by a facility attribute. You can choose to resolve the facility to a relative facility if desired. The property sheet displays Common and Facility properties.
The Sort numerically property specifies whether this column can be sorted numerically. In run mode, clicking a column header moves between the three states: sort ascending, sort descending, and unsorted. A small arrow indicates the sort order.
Note: Any column with mixed string and numeric data (like the Value column of the Alarm Grid) will be sorted as a string.
The Facility attribute property specifies the facility attribute that will displayed in the column. Click
to reveal a drop-down menu of all available CygNet facility attributes categorized by type:
Click
to expand each category and select the desired facility attribute.
A generic column can display any kind of scripted data of your choosing using C# or VB.NET at run-time. First configure the column in Canvas and then reference the column by name to pull in CygNet or other values. A generic column can be used to discover data defined in a supporting script. If the column is defined, but no data is defined, then the column is hidden by default.
The cells in a generic column can be configured to be editable in run mode, so that, for example, users could make quick data changes to facilities in a grid format. Changed values are not saved anywhere but in the grid, but they can be saved or otherwise manipulated via script.
The property sheet displays only Common properties.
The Sort numerically property specifies whether this column can be sorted numerically. In run mode, clicking a column header moves between the three states: sort ascending, sort descending, and unsorted. A small arrow indicates the sort order.
Note: Any column with mixed string and numeric data (like the Value column of the Alarm Grid) will be sorted as a string.
A point column presents data for a point by UDC and point attribute. You can choose to resolve the point to a relative facility if desired. The property sheet displays Common and Point properties.
The Sort numerically property specifies whether this column can be sorted numerically. In run mode, clicking a column header moves between the three states: sort ascending, sort descending, and unsorted. A small arrow indicates the sort order.
Note: Any column with mixed string and numeric data (like the Value column of the Alarm Grid) will be sorted as a string.
The Point attribute property specifies the point attribute that will be displayed in the column. Click
to reveal a drop-down menu of all available CygNet point attributes categorized by type:
Click
to expand each category and select the desired point attribute.