CygNet GCM Nomination Grid – Properties
The following table lists and describes properties of the CygNet GCM Nomination Grid as they are exposed on the Property Sheet and/or in the tool's script editor. Many of these properties are also exposed on a tool's (OCXProperties) property sheets. A property's name sometimes varies depending on where it appears.
Browse by letter: [A] [B] [C] [D] [E] [F] [G] [H] [L] [O] [R] [S] [T] [V]
| Property Sheet | Script Editor | Description |
|---|---|---|
|
Appearance |
Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 — Flat or 1 — 3D. Default is 0 — Flat. |
|
|
BackColor |
BackColor specifies a background color for the object or grid. Note that if an object’s [AlarmElement] property is set to Background Color and a primary point is assigned to the object, the background color will change in Run mode to reflect the point status. The default is Automatic, which is the background color of TheView for most objects.
Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).' |
|
|
BorderStyle |
BorderStyle specifies the border style of the object boundary. Most tools use one of these sets of options:
The Panel Switch Tool uses these options:
For the Box, Frame, and Text tools, the BorderStyle property specifies the style of the object’s foreground lines. The options are:
The default for the Box Tool is 0 — Normal. The default for the Frame Tool is 1 — 3D. The default for the Text Tool is 4 — None. If you use 2 — Sunken or 3 — Raised and the effect is not visible, change the object’s HiliteColor. If you use 0 — Normal, 2 — Sunken, or 3 — Raised, you can set the border width using the PenWidth property. For TheFrame/TheView, the BorderStyle property specifies both the style of the object's border and whether the object can be resized by the user in Run mode. The default is 0 — Thin, which means the border is thin and the size is static. The other possible option is 1 — Resizing, which means the border is thicker and can be resized. See also Appearance. Script subtype is integer. |
|
|
N/A |
Bottom specifies the distance (in pixels) from the top of TheView’s scroll region to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object. See Sizing and Positioning Objects. |
|
|
CellBackColor |
Specifies the background color of a cell. Default is white (RGB 255.255.255). Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).' |
|
|
CellForeColor |
Specifies the foreground color of a cell. Default is black (RGB 0.0.0). Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).' |
|
|
ColumnDefXml |
Specifies the XML used to configure the grid columns. Raw XML can be typed into the text field on the ActiveX properties dialog box or configured via the Columns page on the CygNet GCM Nomination Grid Properties dialog box. If you use the second option, the ColumnDefXml text field auto-populates with XML. |
|
|
ContractHour |
Specifies the contract hour in the time zone of a client computer. Determines the hour at which the contract day begins. This property cannot be changed while the control is running. |
|
|
N/A |
For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects. For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer. The default is 0 — Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:
Script subtype is long. |
|
|
DisplayXml |
Specifies the XML used to configure the display colors. Raw XML can be typed into the text field on the ActiveX properties dialog box or configured via the Display page on the CygNet GCM Nomination Grid Properties dialog box. If you use the second option, the DisplayXml text field auto-populates with XML. |
|
|
N/A |
Enable specifies whether the user is able to interact with the object. Options are 0 — No and 1 — Yes. The default is 1 — Yes. If set to 0 — No, the object is still visible but its context menu is disabled. Other options:
|
|
|
FacilityTag |
The facility tag of the root node in a given navigation hierarchy. Only facilities below this facility in the hierarchy are displayed. |
|
|
FilterXml |
Specifies the XML used to configure filters and filter rules. Raw XML can be typed into the text field on the ActiveX properties dialog box or configured via the Filters page on the CygNet GCM Nomination Grid Properties dialog box. If you use the second option, the FilterXml text field auto-populates with XML. |
|
|
N/A |
FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:
Default is 0 — None. |
|
|
N/A |
FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:
Default is 0 — None. |
|
|
Font |
Font specifies the font for the object. For TheView, this property specifies the default font for text-based objects. For other objects, it specifies the font for the instance of the object. The object’s font takes precedence over the font set for TheView. Click … to view the Font dialog box, which you can use to configure the font. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string. Note: In script, you can set font properties using "-13, Arial" for example. |
|
|
GeneralXml |
Reflects the General page values on the Properties dialog box. |
|
|
N/A |
Group groups objects into a discrete sequence that can be navigated using the arrow keys. Options are 0 — No and 1 — Yes. The default is 0 — No. To use this property: 1. Add objects that use the Group property to a screen. 2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen). 3. Decide where in the spatial configuration logical groups begin and end. 4. Mark the beginning of a group by setting the Group property to 1 — Yes for the first object in the group. 5. Set Group set to 0 — No for other objects in the group. The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 — Yes and 2) that use a Group property set to 0 — No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen. This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property. Script subtype is long. See also Tabstop. |
|
|
GroupHierarchy |
Specifies the name of the group hierarchy you want to use and see displayed. The available options correspond to group hierarchies already set up in your Group Service for a given site. Only the names of possible root nodes appear. This is the same as that entered on the Settings page of the GCM device editor. |
|
|
GroupService |
Specifies the Site.Service of the Group service containing the group hierarchy. Be sure to select the Group service from the correct site. This is the same as that entered on the Settings page of the GCM device editor. |
|
|
GroupView |
Specifies the parent-child relationships between the components associated with the same component hierarchy root node. Multiple views may be created to provide different methods of filtering and displaying data, such as State, Route, and Operator, or Operator and State. This is the same as that entered on the Settings page of the GCM device editor. |
|
|
N/A |
HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled. Script subtype is long. |
|
|
HistoricalDate |
Enter a past date in this field to view calculations from that past date. You must also set the property HistoricalMode to 1 — Yes. |
|
|
HistoricalMode |
Use this setting to view screens for dates prior to the current date. Options are 0 — No or 1 — Yes. Default is 0 — No. You must also enter a specific value for the property HistoricalDate. |
|
|
N/A |
Layer identifies the layer on which the object resides. Script subtype is Boolean. |
|
|
N/A |
Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object. See Sizing and Positioning Objects. |
|
|
LockedColumns |
Number of leftmost columns to lock when scrolling horizontally. |
|
|
LockedRows |
Number of topmost rows to lock when scrolling vertically. |
|
|
N/A |
(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string. |
|
|
N/A |
Displays the OCXProperty dialog box unique to the object. |
|
|
RefreshRate |
Rate at which data automatically refreshes. On large hierarchies, the refresh can be slow — don’t refresh too often. |
|
|
N/A |
Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object. See Sizing and Positioning Objects. |
|
|
RowDefXml |
Specifies the XML used to configure the grid rows. Raw XML can be typed into the text field on the ActiveX properties dialog box or configured via the Rows page on the CygNet GCM Nomination Grid Properties dialog box. If you use the second option, the RowDefXml text field auto-populates with XML. |
|
|
StateColorEvaluation |
[StateColorEvaluation] specifies whether the object’s color is based on its point state or its alarm state. Options are 0 — Point State and 1 — Alarm State or 1 — ePOINT_STATE and 2 — eALARM_CONDITION. The default is 0 — Point State or 1 — ePOINT_STATE. |
|
|
StateColorMode |
[StateColorMode] Specifies if and how the object will show the alarm point’s state color: shown in a single color (1 — Single), dual colors (2 — Dual), or not at all (0 — Off). The default is Single. Options include:
Most tools have a Single mode. That is, they can reflect the point state color in a single element. The element is defined by an object’s [AlarmElement] property to specify if the state color will be shown in the object’s foreground or background. Objects that have [AlarmElement] options of both Foreground Color and Background Color, such as the Text Tool or a closed shape (ellipse, rectangle, polyline), can be configured using the [StateColorMode] property to show the point state color in dual mode; that is, both the Foreground and Background. For tools with a Dual mode, you must select the foreground and background colors using the [UseCustomStateColors] property. The default is 1 — eOFF. Options include:
|
|
|
N/A |
Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 — No and 1 — Yes. Default is 1 — Yes. Script subtype is long. Note: To set the tab order, use the Objects option on the Layout menu. |
|
|
N/A |
Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string. |
|
|
N/A |
Top specifies the distance (in pixels) from the top of TheView’s scroll region to the top of the object. See Sizing and Positioning Objects. |
|
|
N/A |
Visible secifies whether the object is visible in Run mode. Options are 0 — No or 1 — Yes. Default is 1 — Yes. Note: Objects are always visible in Edit mode, regardless of how this property value is set. You can also:
|


