The CygNet 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 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 CygNet grid control offers three selection units. The Selection unit property determines the grid units that may be selected in run mode. Options included:
The default value is Full row.
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.
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, Facility, and Color 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. Note that when a generic column is set to editable the Color properties are not configurable.
The property sheet displays only Common and Color 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 history column is used to add a sparkline chart in each cell for a specified UDC. You can choose to resolve the point to a relative facility, or use absolute or relative dates, if desired. The property sheet displays Common and History properties.
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, Point, and Color 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.
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 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.
Use the Facility filter property to limit the data presented in the control to any CygNet filter 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.