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 Grid Column Configuration dialog box contains the properties required to configure each column in your grid. There are four types of columns that can be configured in a CygNet grid: a Facility column, a Generic column, a History column, and a Point column. The number of defined columns is listed on the property label once all are configured.

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 > Common property group (All column types)

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 > Color property group (Facility, Generic, and Point columns)

The Background color property specifies the color used for the background of the grid cell.

For a Generic and Facility column

The color can be sourced from one of two options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related 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.
2. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal two 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.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

For a Point column

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related 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.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three 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.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• 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.

For a Generic and Facility column

The color can be sourced from one of two options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related 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.
2. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal two 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.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

For a Point column

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related 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.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three 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.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• 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.

For a Generic and Facility column

The color can be sourced from one of two options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related 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.
2. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal two 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.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

For a Point column

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related 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.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three 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.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• 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.

Column configuration > Facility property group (Facility column 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.

The Resolve to a relative facility check box redirects the source of the facility to a relative facility, overriding the configured source facility. Once selected a list of configured Relative links is displayed.

See Using Relative Facilities in Canvas for more information about configuring and scripting relative facility links.

The Relative link property specifies a list of all available relative facility paths. Click to reveal a drop-down menu of all available relative facility definitions (relative links). Select a link from the list. If an order-in-type attribute is specified for the selected link, the Order in type field will display.

The Order in type property specifies the attribute value used to represent the order in type (facility ordinal) if the relative facility definition is configured for one. It is possible to have multiple relative facility definition sets with the same definition name. In this case, if the specified Relative link is configured for ordinalization, then you need to configure the attribute value in the box.

Column configuration > History property group (History column only)

The UDC property specifies the UDC for which the control is to display data. Click to select a UDC using the Select UDC dialog box.

The Resolve to a relative facility check box redirects the source of the facility to a relative facility, overriding the configured source facility. Once selected a list of configured Relative links is displayed.

See Using Relative Facilities in Canvas for more information about configuring and scripting relative facility links.

The Relative link property specifies a list of all available relative facility paths. Click to reveal a drop-down menu of all available relative facility definitions (relative links). Select a link from the list. If an order-in-type attribute is specified for the selected link, the Order in type field will display.

The Order in type property specifies the attribute value used to represent the order in type (facility ordinal) if the relative facility definition is configured for one. It is possible to have multiple relative facility definition sets with the same definition name. In this case, if the specified Relative link is configured for ordinalization, then you need to configure the attribute value in the box.

The Sparkline color (or Color) property specifies the color of the sparkline. Click to customize the color using the color picker.

The Begin date or Start or Start date property specifies the start date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.

The End date or End property specifies the end date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.

The Use relative dates check box indicates whether to use relative dates and time in the history column of the CygNet Grid. If unchecked all dates and time will be absolute.

The Begin relative date or Relative start date or Start property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

The End relative date or Relative end date or End property specifies a wildcard string defining the amount of time by which to adjust end date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative end date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

The Auto range x-axis check box indicates whether the sparkline's x-axis is constrained to the range of values for the associated point or fixed to the configured time range (default). Configure the date and time range in the Range properties below.

The Auto range y-axis check box indicates whether the sparkline's y-axis is constrained to the range of values for the associated points (default) or fixed to the configured minimum and maximum values. Configure the y-axis scale in the Maximum Y value and Minimum Y value below.

The Minimum Y value property specifies the minimum value to use on the sparkline's y-axis when the Auto range - y-axis property is set to fixed (disabled).

The Maximum Y value property specifies the maximum value to use on the sparkline's y-axis when the Auto range - y-axis property is set to fixed (disabled).

Column configuration > Point property group (Point column only)

The UDC property specifies the UDC for which the sparkline is to display data. Click to select a UDC using the Select UDC dialog box.

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 Resolve to a relative facility check box redirects the source of the facility to a relative facility, overriding the configured source facility. Once selected a list of configured Relative links is displayed.

See Using Relative Facilities in Canvas for more information about configuring and scripting relative facility links.

The Relative link property specifies a list of all available relative facility paths. Click to reveal a drop-down menu of all available relative facility definitions (relative links). Select a link from the list. If an order-in-type attribute is specified for the selected link, the Order in type field will display.

The Order in type property specifies the attribute value used to represent the order in type (facility ordinal) if the relative facility definition is configured for one. It is possible to have multiple relative facility definition sets with the same definition name. In this case, if the specified Relative link is configured for ordinalization, then you need to configure the attribute value in the box.

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 configuration property is where you specify the source of the facility (and maybe the SiteService) for the row of the CygNet grid to use. The source for the facility can be explicitly configured for this row or it can be inherited from the screen or another control. If Row configuration is set to <Self> then you also need to provide a SiteService. This could be manually configured or inherited.

Click to reveal a drop-down area where you can configure the source Facility and source SiteService for the grid's rows. Each option is described below.

The Facility property specifies the source facility for the grid's rows. Options include:

• Source — Options include <Self>, Screen (default), or a list of Sender controls.
  • <Self> — Select <Self> to explicitly configure the facility for this control, which can be further filtered,.
  • Screen — Select Screen to inherit the facility from the screen for this control. By default, the sender is the Screen control if no other senders have been configured. Once Screen is selected Inherited from Screen will display for the Facility property.
  • Sender — A list of sender controls that have been configured with a facility will be displayed. Select the name of the control that will send its facility to this control. By default, the sender is the Screen control if no other senders have been configured. Once a sender control has been specified its name will display in the Source field.
• Filter —

  The Facility filter option is visible only if the Facility Source is <Self>.

  Use the Facility filter property to limit the data presented in the control (or row or layer) to any CygNet facility attribute set up for your CygNet installation. Click to open the Facility Filter dialog box where you can create a custom filter rule. The filter rule is displayed in the property label; you do need to open the Facility Filter dialog box to edit the rule.

The SiteService property specifies the source SiteService for the grid's rows. SiteService is only available for configuration if the facility source is <Self>. Options include:

• Source — Options include <Self> or Screen.
  • <Self> — Select <Self> to explicitly configure the SiteService for this control or screen element. A SiteService selector is displayed:
    • SiteService — The SiteService property specifies the SiteService for which the control (or screen or screen element) is to display data. Click to select a service using the Select Service dialog box.
  • Screen — Select Screen to inherit the SiteService from the screen for this control or screen element. By default, the sender is the Screen control if no other senders have been configured.

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

• Single — Only one item can be selected at a time.
• Multiple — Items are added to the selection when they get clicked and get removed when they get clicked again.
• Extended — Items are added to the selection only by combining mouse clicks with the Ctrl key or Shift key.

The default value is Single.

In script, use SelectionMode with the SelectAll method and SelectedRows property (read-only) to aid in multi-row selection:

• SelectAll method — If the SelectionMode property is Multiple or Extended, SelectAll will select all rows in a grid and SelectedRows will return the matching DataRow objects. SelectAll will not obviously change the selection if SelectionMode is Single.
• SelectedRows property (read-only) — SelectedRows will be restricted to a single row if SelectionMode is Single. Otherwise SelectedRows can contain multiple rows to be retrieved via script.

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.