Alarm Grid Properties
The Alarm Grid supports the following properties, which are available via the Properties pane and the Canvas script editor. Click next to any property name in the Properties pane to see a short description for the selected property.
See Accessing Screen Objects for more information about how to view control objects in script in the Canvas application.
Categorizing, Sorting, and Finding Properties
You can click
(Categorize), click
(Alphabetical within Category) or click
(Search) within the properties using the features located immediately above the properties list. The search box is useful to help locate a property when an object contains many properties. For clarity, when you enter a search term, items matching your entry string remain displayed and non-matching items are temporarily hidden. Clear the search box to display the full properties list again.
You can expand and collapse each property category by clicking
or
next to the group name or simply clicking anywhere in the category heading.
Alarm Grid Control Properties
The following tables describe the property names visible in the Properties pane user interface (UI) and the corresponding script property name.
| UI Property | Script Property | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Name Type Style | ||||||||||||
|
ControlName |
The Name property specifies the unique identifier for this control. Valid characters are A-Z, 0-9, and underscore (_). Special characters and spaces are not permitted. Names cannot start with a number; an underscore will be prefixed if the control name starts with a number. The default value is the object name and the numeric instance. The control's Name is also displayed on the Controls view of the Screen pane. |
|||||||||||
|
ControlType |
The read-only Type property displays the type for the control: Button, Chart, CygNet Grid, Edit Box, Object Container, Search Box, Tag Chooser, etc. … The control's Type is also displayed on the Controls view of the Screen pane. |
|||||||||||
|
|
Styles are created in two ways:
Tip: You can also change a control's Style on the Controls view of the Screen pane. |
|||||||||||
Location
|
||||||||||||
|
Height |
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 |
|||||||||||
|
HorizontalResizeMode |
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. |
|||||||||||
|
Layer |
Tip: You can also edit a control's Layer on the Controls view of the Screen pane. Note: Layer visibility can be controlled at runtime via the AddLayer, HideLayer, SetLayerVisibility, and ShowLayer methods on the Screen object. |
|||||||||||
|
IsLocked |
Tip: You can also toggle the lock setting of a control using the Settings pane (click on the |
|||||||||||
|
VerticalResizeMode |
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. |
|||||||||||
|
IsVisible |
Tip: You can also change a control's Visible setting on the Controls view of the Screen pane. |
|||||||||||
|
Width |
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 |
|||||||||||
|
X |
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 |
|||||||||||
|
Y |
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 |
|||||||||||
|
ZIndex |
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 |
|||||||||||
Script ![]() |
||||||||||||
|
Tip: You can also change the Include in Script setting on the Controls view of the Screen pane. |
||||||||||||
Grid
|
||||||||||||
|
AlarmFilter |
The Alarm filter property is used to limit the data that is presented in the Alarm Grid by configuring alarm filtering rules. Click |
|||||||||||
|
ToolbarFilters |
|
|||||||||||
|
Toolbar filters > Name |
The Name property specifies the name of the alarm filter that appears on the Alarm Grid's toolbar. |
|||||||||||
|
Toolbar filters > Alarm filter |
The Alarm filter property specifies the filter rules for each toolbar filter. Configure the filter rule using the standard CygNet Alarm Filter dialog box. |
|||||||||||
|
Toolbar filters > Tooltip |
The Tooltip property specifies a tooltip that will display when your hover over the alarm filter in the Alarm Grid's toolbar. |
|||||||||||
|
IconColumn IconColumn.ColorSource IconColumn.Ranges IconColumn.ShowIcon |
Configure Icon Color Source, Alarm Priority Ranges, and Custom Icon
To create a customized alarm
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. Additional Resources
|
|||||||||||
|
ColorConfiguration |
The Color configuration property is a control-level property that governs all color settings for the columns in the Alarm Grid. Click
|
|||||||||||
|
Background color |
ColorConfiguration.BackgroundSource ColorConfiguration.BackgroundSelfColor |
The Background color property specifies the color used for the background of the grid cell. The color can be sourced from one of several options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto); b) the color will be sourced from the point state of the associated alarm (by selecting BackgroundColor, ForegroundColor, or SingleColor); or c) the color can be customized (by selecting Self). The default value is BackgroundColor. Options include: For each color property select the Source and Color:
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. |
||||||||||
|
Text color |
ColorConfiguration.TextSource ColorConfiguration.TextSelfColor |
The Text color property specifies the color used for the text of the Alarm Grid cell. The text color is sometimes known as the foreground color. The color can be sourced from one of several options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto); b) the color will be sourced from the point state of the associated alarm (by selecting BackgroundColor, ForegroundColor, or SingleColor); or c) the color can be customized (by selecting Self). The default value is ForegroundColor. Options include: For each color property select the Source and Color:
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. |
||||||||||
|
Border color |
ColorConfiguration.BorderSource ColorConfiguration.BorderSelfColor |
The Border color property specifies the color used for the border of the grid cell. The color can be sourced from one of several options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto); b) the color will be sourced from the point state of the associated alarm (by selecting BackgroundColor, ForegroundColor, or SingleColor); or c) the color can be customized (by selecting Self). The default value is Auto. Options include: For each color property select the Source and Color:
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. |
||||||||||
|
Header background color |
ColorConfiguration.HeaderBackgroundSource ColorConfiguration.HeaderBackgroundSelfColor |
The Header background color property specifies the color used for the background of the grid's header row. The color can be sourced from one of two options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto), or b) the color can be customized (by selecting Self). The default value is Auto. Options include: For each color property select the Source and Color:
|
||||||||||
|
Header text color |
ColorConfiguration.HeaderTextSource ColorConfiguration.HeaderTextSelfColor |
The Header text color property specifies the color used for the text on the grid's header row. The color can be sourced from one of two options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto), or b) the color can be customized (by selecting Self). The default value is Auto. Options include: For each color property select the Source and Color:
|
||||||||||
|
Grid background color |
ColorConfiguration.GridBackgroundSource ColorConfiguration.GridBackgroundSelfColor |
The Grid background color property specifies the color used for grid's background. The color can be sourced from one of two options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto), or b) the color can be customized (by selecting Self). The default value is Auto. Options include: For each color property select the Source and Color:
|
||||||||||
|
Display alarm acknowledgment |
ColorConfiguration.BackgroundBlink ColorConfiguration.TextBlink ColorConfiguration.BorderBlink |
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. Note: The blink interval is configurable in the Canvas Settings page in the Backstage view. |
||||||||||
|
ColumnDefinitions ColumnDefinitions.Count ColumnProperties ColumnTypes |
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:
Click Column OrderOnce defined, columns can be easily reordered by selecting, then dragging and dropping the item to a new location. Column Types
|
|||||||||||
|
Column configuration > Alarm property group (Alarm columns only) An alarm column presents data for a point by an alarm attribute. |
||||||||||||
|
Alarm attribute |
|
The Alarm attribute property specifies the alarm attribute that will be displayed in the column. Click
|
||||||||||
|
Value format |
The Value format property specifies the format for the point's value using any of the valid .NET standard or custom numeric format strings. The value format applies to a point's Value, Primary Value, and Alternate Value properties. The default value format is #,##0.00, which corresponds to 123,456,789.12. Formats use # and 0, with a period (.) as the decimal separator and comma (,) as the thousands separator. Add additional zeros to show more decimal places. |
|||||||||||
|
Date and time format |
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 any point's timestamp property. Use this property to override the Default date format, which is configured in the Application settings page of the Backstage view. The default date format is YYYY/MM/DD HH:MM:SS.fff, which corresponds to 2024/01/01 10:20:30.0001. All timestamps are local client time. If an invalid format is configured for the Date and time format, the control will automatically use the format configured for the Default date format saved in the global settings file, and configured in the Backstage view. 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/2024, "F" is the full date/time pattern and corresponds to Monday, January 1, 2024 1:45:30 PM. |
|||||||||||
|
Column configuration > Common property group (All column types (Alarm, Facility, Generic, Point)) |
||||||||||||
|
Name |
The Name specifies the name that appears in the column header. |
|||||||||||
|
Type |
The Type property is a read-only text box that shows the column Type for the grid. |
|||||||||||
|
Visible |
The Visible check box indicates whether to display the column in run mode. |
|||||||||||
|
Width |
The Width property specifies the width of the column in pixels. Set the value to 0 to auto size the width. If the column width is not configured (i.e., the width is set to 0), the column will be auto sized. If the column width is configured with a fixed column width, no resizing will occur. |
|||||||||||
|
Text alignment |
The Text alignment property specifies the horizontal alignment of the text in the column (all column types except Image). The options are Left, Right, Center, and Justify. The default value is Left. When published to TWC the Justify option is indistinguishable from the Left option. |
|||||||||||
|
Read only (Generic columns only) |
IsReadOnly |
|
||||||||||
|
Sort numerically |
|
The Sort numerically property specifies whether this column can be sorted numerically (all column types except History and Image). 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. |
||||||||||
|
Column configuration > Facility property group (Facility columns only) 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. |
||||||||||||
|
Facility attribute |
The Facility attribute property specifies the facility attribute that will displayed in the column. Click
Click |
|||||||||||
|
Column configuration > Point property group (Point columns only) 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. Point column types also support a Summary row at the bottom of the grid that can show the following values for the data in the column: a total Count, a Sum, the Min value, the Max value, the Min and Max values, and the Mean value. |
||||||||||||
|
Point attribute |
The Point attribute property specifies the CygNet point attribute that will be displayed in the column. Click
Click |
|||||||||||
|
Value format |
The Value format property specifies the format for the point's value using any of the valid .NET standard or custom numeric format strings. The value format applies to a point's Value, Primary Value, and Alternate Value properties. The default value format is #,##0.00, which corresponds to 123,456,789.12. Formats use # and 0, with a period (.) as the decimal separator and comma (,) as the thousands separator. Add additional zeros to show more decimal places. |
|||||||||||
|
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 any point's timestamp property. Use this property to override the Default date format, which is configured in the Application settings page of the Backstage view. The default date format is YYYY/MM/DD HH:MM:SS.fff, which corresponds to 2024/01/01 10:20:30.0001. All timestamps are local client time. If an invalid format is configured for the Date and time format, the control will automatically use the format configured for the Default date format saved in the global settings file, and configured in the Backstage view. 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/2024, "F" is the full date/time pattern and corresponds to Monday, January 1, 2024 1:45:30 PM. |
||||||||||||
|
Column configuration > Summary property group (Point column only) |
||||||||||||
|
Summary type |
The Summary type property specifies the type of values presented in the grid summary row at the bottom of the grid. Click
See Row summary update rate below for information about the update rate at which the grid will recalculate row summaries after a value changes. |
|||||||||||
|
Show label |
The Show label check box indicates whether to display a label providing context for the grid summary row value. Options include: Sum:, Min:, Max:, MinMax:, Count:, and Mean:. |
|||||||||||
|
Grid properties continued... |
||||||||||||
|
CustomContextMenuItems |
The custom context menu options will appear at the bottom of the fixed context menu options, separated by a line. Each custom context menu item has a title and an event script ID; items can be designated as a separator; and custom context menus support nested menu items. Click |
|||||||||||
|
Context menu items > Title |
|
|||||||||||
|
Context menu items > Is separator |
|
|||||||||||
|
Context menu items > Script event ID |
|
|||||||||||
|
DoubleClickBehavior
Note: The script property for Double click mode is DoubleClickBehavior. |
The Double click mode property determines the action to take when you double-click a row in run mode. The Facility sender mode must be set to Double click. Options are:
The default value is Hyperlink. Notes:
|
|||||||||||
|
|
FacilitySender FacilitySource FacilityTagListFilter GridFacilitySenderMode |
The Facility sender mode property determines how facilities are sent to other controls. There are four options:
Note: If Double click is selected for the Facility sender mode property, and Hyperlink is selected for the Double click mode property, and a Hyperlink mode and Screen path are configured, two actions will be performed when a row is double-clicked:
Script Event If Double click is selected for the Facility sender mode property, and Script is selected for the Double click mode property, the selected facility will be sent to any control(s) on the screen configured to receive its facility from the grid, and the script event Double Click Cell will fire using the facility received from the grid. Sending and receiving facility tagsSome controls on the same screen allow for the sending of facility information from one control to another.
ExampleAdd a control to a screen (e.g., a Tag Chooser or Grid) and configure it as a facility sender to send a facility to the screen. Add another control to the screen (e.g., a Text Tool or Donut) and configure it to receive the facility from the screen. In this scenario the Tag Chooser or Grid will send a facility to the screen and the screen will then send the facility to a Text Tool or the Donut. |
||||||||||
|
Row source mode |
The Row configuration property is where you specify the source of the data to use in the rows of the Alarm Grid: either by SiteService or by facilities. The source for the SiteService can be the Screen or <Self>, where you can specify the Common Alarm Service (CAS) providing the alarm data. The source for the facilities can be from the screen or another control. Click The Row source mode property specifies the source of the SiteService or the source of the facilities for the Alarm Grid row data. Select one of the radio buttons to indicate whether the rows' data is received from a SiteService or from facilities. Options are described below. |
|||||||||||
|
Row config > Row source mode > Sourced by SiteService |
AlarmGrid.SiteService SiteServiceSender SiteService.DisplayString SiteService.DomainSiteService SiteService.DomainSiteService.DomainId SiteService.DomainSiteService.Service SiteService.DomainSiteService.Site SiteService.DomainSiteService.SiteService SiteService.DomainSiteService.SiteService.Service SiteService.DomainSiteService.SiteService.Site SiteService.IsBroadcastSourced SiteService.IsSelfSourced SiteService.SiteService SiteService.Source |
The Sourced by SiteService option specifies the source SiteService for the Alarm Grid's rows.
|
||||||||||
|
Row config > Row source mode > Sourced by facilities |
FacilitySender FacilitySource FacilityTagListFilter |
The Sourced by facilities option specifies the source facilities for the Alarm Grid's rows.
|
||||||||||
|
RowSummaryUpdateRate |
The Row summary update rate property specifies the rate (in milliseconds) at which the grid will recalculate row summaries after a value changes in a point column. Longer rates will improve performance by not recalculating as often. When a value in a cell is updated, the summary row will be recalculated. However recalculation does not happen immediately or for every update; it is throttled by the Row summary update rate. When a recalculation is requested, Canvas will delay for the duration of the update rate. This allows other updates to come in that may affect the recalculated values. Recalculation requests that come in during that delay will be ignored. In this way, no matter how often values change, Canvas will not recalculate the summary row value more often than the set rate. The default value is 1000 milliseconds (1 second). Note: See Summary properties above for information about configuring grid row summaries. |
|||||||||||
|
SelectionMode SelectionUnit SelectedRow SelectedRows |
The default value is Single. In script, use SelectionMode with the SelectAll method and SelectedRows property (read-only) to aid in multi-row selection:
|
|||||||||||
Hyperlink
|
||||||||||||
|
HyperlinkMode |
The Hyperlink mode property specifies how to handle navigation when clicking an element (e.g., row in a grid, Navigation Button, Shape, or Text Tool). Specify the Screen file source to open in the Screen path property. Several hyperlink navigation options are available:
The default value is Open. See Hyperlinking Screens for more information about this functionality. Note: Grid cells can display a different facility from that configured for a grid row. The double-click hyperlink action will pass the cell or row’s facility to other controls on the screen configured to receive it AND to the receiving screen. |
|||||||||||
|
ScreenFileSource |
This property specifies the source of the file, object file, screen file, image file, or video file. Options include:
|
|||||||||||
|
ScreenPath |
The Screen path property specifies the screen that will open when an element (e.g., a row in a Grid, Image or Shape on a Map, Navigation Button, Shape, or Text Tool) is clicked. Browse for the screen file. Click
|
|||||||||||
Generic
|
||||||||||||
|
String |
|
|||||||||||
|
YesNo |
|
|||||||||||
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. 
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.
