CygNet CAS View Control – Methods
The following table lists and describes methods of the CygNet CAS View Control. Methods are accessed using the control's script editor. See CxHmiCas CxHmiCas3 Methods for more information about using these methods in script.
| Method | Description |
|---|---|
|
The AddFilter method changes the current unit set. |
|
|
The AllowUserChanges method allows or disallows the user to change properties at runtime. |
|
|
The ClearFilters method clears all rules and filters from the control. |
|
|
The ClearSilenceTime method clears out any alarm silence time that may have been set. This will cause any alarms that would cause sound to be played, but had been silenced, to resume playing sound. |
|
|
The EnableAllRules method enables or disables all rules and vectors, either unilaterally, or for the specified level. Passing True for Enable enables all rules; passing False disables all rules. |
|
|
The EnableCASViewCustomAttributeFiltering method enables or disables the use of CAS custom attributes. |
|
|
The EnableDClickPropDlg method enables or disables launching of a Point Properties dialog box when a row is double-clicked. |
|
|
The EnableRule method enables or disables the specified rule or set of rules for the specified level. True enables the rule or vector; False disables it. |
|
|
The EnableSound method enables or disables sounds for a particular alarm priority category. |
|
|
The GetAlarmRefreshSec method returns the alarm refresh rate in seconds. |
|
|
The GetCASViewCustomAttribute method returns the value of a CAS View Control custom attribute by either the supplied attribute name or description. |
|
|
The GetFilter method returns the XML representation of the set of filter rules. |
|
|
The GetFilterString method returns the string representation of the filter. |
|
|
The GetFirstVisibleAlarm method returns the row of the first alarm visible on the screen. |
|
|
The GetGridValueForTag method returns the grid value for a specified point property. |
|
|
The GetLastVisibleAlarm method returns the row of the last alarm visible on the screen. |
|
|
The GetNumberRows method returns the total number of rows (alarms) in the grid. |
|
|
The GetPropertyForTag method returns a property value for a specified point. |
|
|
The GetRuleNames method returns the names of all rules or sets of rules that have a configured name for the specified level. Separate arrays are returned for rules that are enabled and for rules that are disabled. |
|
|
The GetRunningServices method returns the alarm category of the selected alarm. |
|
|
The GetSelectedAlarmCategory method returns the alarm category of the selected alarm. |
|
|
The GetSelectedAlarmFacility method returns the facility ID of the selected alarm. |
|
|
The GetSelectedAlarmPointId method returns the short point ID of the selected alarm. |
|
|
The GetSelectedAlarmPointIdLong method returns the long point ID of the selected alarm. |
|
|
The GetSelectedAlarmPriority method returns the alarm priority of the selected alarm. |
|
|
The GetSelectedAlarms method returns an array of point tags of the currently-selected alarms. |
|
|
The GetSelectedAlarmService method returns the service of the selected alarm. |
|
|
The GetSelectedAlarmSite method returns the site of the selected alarm. |
|
|
The GetSelectedAlarmStatus method returns the status of the selected alarm. |
|
|
The GetSelectedAlarmTimestamp method returns the latest timestamp of the selected alarm. |
|
|
The GetSelectedAlarmUniformDataCode method returns the uniform data code of the selected alarm. |
|
|
The GetSelectedAlarmUserStatus method returns the user status of the selected alarm. |
|
|
The GetSelectedAlarmValue method returns the value of the selected alarm. |
|
|
The GetServiceVersionNumber method returns the service version of the currently-selected alarm. |
|
|
The GetStoppedServices method returns the list of stopped services. |
|
|
The GetTagForRow method returns the alarm tag for the specified row. |
|
|
The GetTooltipRow method returns tooltip row information. |
|
|
The GetTooltipString method returns the tooltip display string. |
|
|
The GetTooltipText method returns tooltip text information. |
|
|
The IsSelectedAlarmAck method returns True if the currently-selected alarm is acknowledged. |
|
|
The IsSelectedAlarmClear method returns True if the currently-selected alarm is clear. |
|
|
The IsSelectedAlarmHidden method returns True if the currently-selected alarm is hidden. |
|
|
The IsSelectedAlarmSet method returns True if the currently-selected alarm is set. |
|
|
The IsSelectedAlarmSuppressed method returns True if the currently-selected alarm is suppressed. |
|
|
The IsShowAlarmColor method returns the value of the ShowLineColor property. |
|
|
The IsWrapColumns method returns the value of the WrapColumns property. |
|
|
The MenuSelection method selects an item from the context menu. |
|
|
The Properties method invokes a Point Properties dialog box for the currently-selected alarm. |
|
|
The RefreshContents method refreshes the contents of the CAS View control with all alarms that meet the configured set of rules. After modifying the filter rules, this must be called to reset the view with the changes. |
|
|
The RemoveFilter method removes a filter specified by a property, operator, and value. |
|
|
The RequestAlarmRefreshRateChange method requests a change in the shared alarm cache refresh rate. |
|
|
The RestoreInitialFilter method restores the filter state to the original filter that is configured for the control. |
|
|
The SelectAlarms method selects a range of alarms. |
|
|
The SetAlarmRefreshSec method sets the alarm refresh rate in seconds. |
|
|
The SetCASViewCustomAttribute method sets the value of a CAS View Control custom attribute identified by either the attribute name or description. |
|
|
The SetControlLabel method sets the control’s label for identification in the log file. |
|
|
The SetFilter method creates a filter rule set for the CAS View Control with the provided XML string. |
|
|
The SetSiteServices method sets the list of Site.Services for which to display alarms. |
|
|
The SetSort method sets the sorting options. |
|
|
The SetTooltipString method sets the tooltip display string. |
|
|
The SetVisibleRow method automatically selects and scrolls the grid to the specified row. |
|
|
The ShowHiddenAlarms method sets whether or not hidden alarms are shown. |
|
|
The SilenceAlarms method silences all alarms that would cause sounds that are older than or equal to the provided timestamp. |
|
|
The StartRefresh method starts display refresh. |
|
|
The StopRefresh method stops display refresh. |
|
|
The TooltipTokenDlg method displays a Tooltip Message Chooser dialog box, and returns the selected token string. |


