AlarmBanner.DeselectAndScrollToTop
Include the AlarmBanner.DeselectAndScrollToTop function in your script if any of the ViewX clients on your system have the Scroll to top on acknowledge, remove or manual redirect option feature enabled and that behavior is to be replicated with alarms that are acknowledged by script.
You use the AlarmBanner.DeselectAndScrollToTop function in conjunction with the AlarmBanner.ScrollToTopEnabled property to determine whether the Scroll to top on acknowledge, remove or manual redirect option feature is enabled on the client from which the script is called.
| Syntax |
AlarmBanner.DeselectAndScrollToTop |
| Description |
Use to perform the required Scroll to top on acknowledge, remove or manual redirect option behavior when an alarm is acknowledged from the Alarm Banner by script. |
| Arguments |
None |
| Returns |
None |
A custom Global Script routine has been written which, in addition to other functionality, enables alarms to be acknowledged by script. The behavior following the alarm acknowledgment is to be the same as if the user had used the standard Acknowledge menu option to acknowledge the alarms from the Alarm Banner. This includes the client's Scroll to top on acknowledge, remove or manual redirect option behavior. To facilitate this, the following code is included immediately after the statement that is called to acknowledge the alarm:
If NOT ( AlarmBanner Is Nothing ) Then
If AlarmBanner.ScrollToTopEnabled Then
AlarmBanner.DeselectAndScrollToTop
End If
End If
On ViewX clients on which the Scroll to top on acknowledge, remove or manual redirect option feature is enabled, once the alarm has been acknowledged using the script, the Alarm Banner deselects the acknowledged alarm entry and scrolls to the top of the Alarm Banner list.
On ViewX clients on which the Scroll to top on acknowledge, remove or manual redirect option feature is disabled, if the abnormal condition that caused the alarm still exists, the acknowledged alarm will remain selected and on display in the Alarm Banner. This might result in the Alarm Banner scrolling to that acknowledged alarm's new position in the Alarm Banner list. With an unacknowledged cleared alarm, the alarm is removed from the Alarm Banner on acknowledgment by the script, and the Alarm Banner continues to display the same part of the Alarm Banner list as it did before the acknowledgment.
Further Information