The following table lists and describes properties of the CygNet Event Summary Control 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.
| Property Sheet | Script Editor | Description |
|---|---|---|
| Appearance |
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. |
| AudFilter |
AudFilter |
Specify the AUD event filter as an XML string. |
| AudMaxCacheSize |
AudMaxCacheSize |
Specifies the maximum size of the AUD service cache, between 20,000 and 10,000,000 |
|
AudServices |
Specifies a semicolon-delimited list of AUD Site.Services (for example, "CYGDEMO.AUD; CYGDEMO.AUD1"). |
|
|
Autostart |
Specifies whether the control will automatically initiate Run mode when its container changes to Run mode. Options are 0 - No or 1 - Yes. The default is 1 - Yes. For the Group Grid Tool, AutoStart enables the Facility ID of each row to be automatically configured by a navigation bar. Set to 0 - No only when manually configuring the rows using script. |
|
|
BorderStyle |
BorderStyle specifies the border style of the object boundary. Most tools use one of these sets of options:0 - ibsNone, 1 - ibsRaised, or 2 - ibsLowered, and the default is 0 - ibsNone0 - None or 1 - Fixed Single, and the default is 0 - NoneThe Panel Switch Tool uses these options:0 - ibsLine, 1 - ibsRaised, 2 - ibsLowered, 3 - ibsTop, and 4 - ibsNone, and the default is 0 - ibsLine.For the Box, Frame, and Text tools, the BorderStyle property specifies the style of the object’s foreground lines. The options are: 0 - Normal, 1 - 3D, 2 - Sunken, 3 - Raised, and 4 - NoneThe 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 the object 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. |
|
|
Columns |
Specifies the number of columns that are defined for the object or the XML that represents the list of displayed columns. Use the OCX Properties dialog box to select.For a WatchList Tool, Columns specifies the identifier of each column. Items are semicolon separated. |
|
|
ContextMenuXml |
ContextMenuXml identifies an XML string that defines the contents and Event IDs for the object’s custom context menu. |
|
| 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. |
|
|
EarliestDate |
Specifies the earliest date for the control. If the date range is relative the date is calculated based on the current date/time. Format is MM/DD/YYYY hh:mm:ss AM/PM. The default is the current system date and time. |
|
|
ElsAlarmFilter |
Specify the ELSALM event filter as an XML string. |
|
|
ElsAlarmServices |
Specifies a semicolon-delimited list of ELSALM Site.Services (for example, "CYGDEMO.ELSALM; CYGDEMO.ELSALM1"). |
|
|
ElsEventFilter |
Specify the ELS event filter as an XML string. |
|
|
ElsEventServices |
Specifies a semicolon-delimited list of ELS Site.Services (for example, "CYGDEMO.ELS; CYGDEMO.ELS1"). |
|
| ElsAlmMaxCacheSize |
ElsAlmMaxCacheSize |
Specifies the maximum size of the ELSALM service cache, between 20,000 and 10,000,000 |
| ElsMaxCacheSize |
ElsMaxCacheSize |
Specifies the maximum size of the ELS service cache, between 20,000 and 10,000,000 |
| 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:
|
|
|
EventSummaryCtrlAttributesDescriptions |
Specify the Event Summary Control Custom Attribute descriptions as an XML string. |
|
|
EventSummaryCtrlAttributesValues |
Specify the Event Summary Control Custom Attribute values as an XML string. |
|
| 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. |
|
| 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. |
|
| N/A |
HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled. Script subtype is long. |
|
|
LatestDate |
Specifies the latest or most recent date for the control. Format is MM/DD/YYYY hh:mm:ss AM/PM. The default is current system date and time. |
|
| 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. |
|
| 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. |
|
| (OCXProperties) | N/A |
Displays the OCXProperty dialog box unique to the object. |
| N/A |
Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object. |
|
| 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. |
|
|
ToolbarLocation |
Specifies the location of the toolbar on the control. Default is 0 - Bottom. Options are 0 - Bottom, 1 - Top, and 2 - None. |
|
| N/A |
Top specifies the distance (in pixels) from the top of TheView’s scroll region to the Top of the object. |
|
| 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:
|