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 allowed. 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.

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.

The Height property specifies the height of the control (or screen).

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:

• None — No resizing occurs.
• Shift — The object will shift horizontally.
• Expand — The object will expand or shrink horizontally the same number of pixels as the screen.
• Proportional — The object expands or shrinks proportionally to the screen.

The default value is None.

The Layer property specifies the name of the layer to which this object is assigned. Layers can be used to show, hide, and edit multiple controls on one layer without affecting controls on another layer.

• Type the name of the layer into the Layer field (the name can be a previously created layer or a new layer).
• All layers are listed on the Layers pane, where you can manage the layers for the screen in design mode and run mode.

The Lock property indicates whether the control is locked to the current position. A locked control cannot be moved via click and drag, or nudged with the arrow keys, or resized.

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:

• None — No resizing occurs.
• Shift — The object will shift vertically.
• Expand — The object will expand or shrink vertically the same number of pixels as the screen.
• Proportional — The object expands or shrinks proportionally to the screen.

The default value is None.

The Visible check box indicates whether the control is visible in run mode.

The Width property specifies the width of the control (or screen).

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.

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.

The Alarm filter property is used to limit the data that is presented in the alarm grid by configuring alarm filtering rules. Click to open the Alarm Filter dialog box, where you can create a custom alarm filter rule. The filter rule is displayed in the property label; you do need to open the Alarm Filter dialog box to edit the rule.

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.

Configure Icon Color Source, Alarm Priority Ranges, and Custom Icon

1. To enable the alarm icon, do the following depending on the control you are configuring:
   • Alarm Grid — Click Show Alarm Icon Column on the Alarm Priority Icon Ranges dialog box, accessible from the Alarm icon column property
   • Detail Control — Click Show alarm icon in the Properties pane
   • Tile View — Click Show alarm icon in the Properties pane
2. Select the source of the icon's color from the Icon color source drop-down menu, which lists the point states of the associated alarm. Options include:
   • BackgroundColor — Specifies that the source of the icon's color corresponds to the alarm's point state background color (%pointstatebackcolor%)
   • ForegroundColor — Specifies that the source of the icon's color corresponds to the alarm's point state foreground color (%pointstateforecolor%)
   • SingleColor — Specifies that the source of the icon's color corresponds to the alarm's point state single color (%pointstatesinglecolor%). This is the default value.

3. Click New icon to add a new icon to the list of priorities. Configure the desired priority and associated icon for each range:

1. Lowest Priority — Type a value to represent the lower end of the priority range. If you are using the CygNet Standard Point Scheme, the total valid range is 0 to 99, with 0 being the lowest and 99 the highest.
2. Priority Range — This read-only column will automatically update to display the range based on the low value you entered, up to the bottom of the next configured range. For example, 0-24, 25-49, 50-74, 75-99 to represent four ranges from 0 to 99.
3. Icon — There are three options for icon usage:

1. Default icon — Use the default icon provided in Canvas.
2. Custom icon without dynamic alarm color — Optionally, supply a custom icon that does not display alarm color. This could be as simple as different shapes and colors that represent the different alarm priority ranges. For example, a blue circle for 0-49, a yellow warning triangle for 50-74, and a red octagon for 75-99, etc. The custom icon must be a Scalable Vector Graphics (.svg) file.
3. Custom icon with dynamic alarm color — Optionally, supply a custom icon that will also include a substituted alarm color somewhere inside the image.

To create a customized alarm

1. Create (or purchase) your own icon. The icon must be a Scalable Vector Graphics (.svg) file. The properties of the SVG image are defined its XML definition.
2. Edit the SVG XML in a text editor and add the string "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"/>
3. Save the file to a known location where it can be accessed by Canvas.
4. Browse for the icon file. Click to select a path and file from the Open / Open File / Select File dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder.

4. Or click (Delete row) to remove a selected row as necessary.
5. Click New icon again to add another priority range and repeat the steps described above.

4. Click OK to accept the priority order, ranges, icon and close the dialog box. Click Cancel to close the dialog box without modification.

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:

• Background color
• Text color
• Border color
• Display alarm acknowledgment

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:

• Source — Click to reveal five options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • BackgroundColor — Select BackgroundColor to specify that the source of the icon's color corresponds to the alarm's point state background color (%pointstatebackcolor%).
  • ForegroundColor — Select ForegroundColor to specify that the source of the icon's color corresponds to the alarm's point state foreground color (%pointstateforecolor%)
  • Self — Select Self to configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
  • SingleColor — Select SingleColor to specify that the source of the icon's color corresponds to the alarm's point state single color (%pointstatesinglecolor%)
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Text color property specifies the color used for the text of the 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:

• Source — Click to reveal five options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • BackgroundColor — Select BackgroundColor to specify that the source of the icon's color corresponds to the alarm's point state background color (%pointstatebackcolor%).
  • ForegroundColor — Select ForegroundColor to specify that the source of the icon's color corresponds to the alarm's point state foreground color (%pointstateforecolor%)
  • Self — Select Self to configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
  • SingleColor — Select SingleColor to specify that the source of the icon's color corresponds to the alarm's point state single color (%pointstatesinglecolor%)
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

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:

• Source — Click to reveal five options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • BackgroundColor — Select BackgroundColor to specify that the source of the icon's color corresponds to the alarm's point state background color (%pointstatebackcolor%).
  • ForegroundColor — Select ForegroundColor to specify that the source of the icon's color corresponds to the alarm's point state foreground color (%pointstateforecolor%)
  • Self — Select Self to configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
  • SingleColor — Select SingleColor to specify that the source of the icon's color corresponds to the alarm's point state single color (%pointstatesinglecolor%)
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

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:

• Background — The background of the cell or text tool will blink when the associated point is in alarm.
• Text — The text in the cell or text tool will blink when the associated point is in alarm.
• Border — The border of the cell or text tool will blink when the associated point is in alarm.

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).

Click to open Grid Column Configuration dialog box.

Column Order

Once 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)

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:

• Alarm Condition
• Set / Reset State
• Alarm Hidden
• Alarm Suppression State
• Point State
• Reported Time
• Alarm Priority Highest
• Alarm Priority Highest Since Ack
• Alarm Priority Highest Category
• Alarm Priority Highest Category Desc.
• Alarm Priority Highest Since Ack Cat.
• Alarm Priority Highest Since Ack Cat. Desc.
• Facility Tag (CAS)
• Alarm Priority
• Primary Value
• Secondary Value
• Alarm Acknowledgment Status

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 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.

Column configuration > Common property group (All column types (Alarm, Facility, Generic, Point))

The Name specifies the name that appears in the column header.

The Type property is a read-only text box that shows the column Type: Generic, Facility, Point, or History.

The Visible check box indicates whether to display the column in run mode.

The Width property specifies the width of the column in pixels. Set the value to 0 to auto size the width.

The Text alignment property specifies the text alignment for the column. The options are Left, Right, Center, and Justify. The default value is Left.

The Read only property indicates whether the cells in a Generic column are editable. (Generic column only)

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.

Column configuration > Facility property group (Facility columns only)

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:

• Facility: General Attributes (The default value is Facility Description.)
• Facility: Text Attributes
• Facility: Table-driven Attributes
• Facility: Yes/No Attributes

Click to expand each category and select the desired facility attribute.

Column configuration > Point property group (Point columns only)

The Point attribute property specifies the CygNet 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:

• Current Values (The default value is Value.)
• Point: General
• Point: Alarm
• Point: Point Reference
• Point: Application
• Point: Scaling
• Point: Hyperpoint
• Point: Alarm (Scheme 0)
• Point: History
• Current Value Status Bits

Click to expand each category and select the desired point attribute.

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 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.

Column configuration > Summary property group (Point column only)

The Summary type property specifies the type of values presented in the grid summary row at the bottom of the grid. Click to select from one of the following options:

• Sum — The sum of the values
• Min — The minimum value
• Max — The maximum value
• MinMax — The minimum and maximum values
• Count — The total number of rows
• Mean — The mean value

See Row summary update rate below for information about the update rate at which the grid will recalculate row summaries after a value changes.

The Show label check box indicates whether to display a label providing context for the summary row value. Options include: Sum:, Min:, Max:, MinMax:, Count:, and Mean:.

Grid properties continued...

The Custom Context Menu Configuration dialog box is where you configure any custom context menu items that will appear in the right-click context menu for the screen or control. Each custom context menu item will call an event into script so that you can customize screen or control behavior.

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 to open the Custom Context Menu Configuration dialog box.

The Title property specifies the menu name to be displayed in the runtime context menu.

The Is separator check box indicates whether this menu item will be a separator line in the menu at runtime. Once saved the separator has no configuration and no children. Separators do not have event IDs. Any event ID on a menu item when it’s converted to a separator is deleted. You can give it a title of 'Separator" or "----------" if desired.

The Script event ID specifies the event ID that will be called when the menu item is selected from the runtime right-click context menu. The event ID is passed in as a parameter into the Custom Context Menu Action event, along with other relevant information in the context of the click, for example, facility or point tag, as appropriate.

The Facility sender mode property determines which mouse-click actions will send facilities to other controls. Options include:

• None — No facilities are sent.
• Single click — A single click will send facilities to another control.
• Double click — A double click will send facilities to another control.
• All facilities — All facilities in the grid will be sent to another control.

The default value is None.

Sending and receiving facility tags

Some controls on the same screen allow for the sending of facility tag information from one control to another.

1. On the sending control configure the Facility sender mode property to send facility tag information to another control on the same screen.
2. On the receiving control configure the Selection mode property (in either CygNet connection or Point configuration section) to Facility tag and select the Facility Source to the sending control.
3. On the receiving control configure a display tag that associates to a facility property, e.g. %FacilityTag%.

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).

See Summary properties above for information about configuring grid row summaries.

The String property specifies a generic string property that can be used when scripting this control. Type a string and reference it in your script as necessary.