EventAlarmChange runs when the indicator goes in or out of the alarm state. To get the current alarm state from within the event handler use This.Alarm.

EventAlarmDblClicked is fired when an alarm is double-clicked.

EventAlarmRefreshRateChanged is fired when the refresh rate of the shared alarm cache is changed.

EventAlarmSelected is fired when an alarm is selected.

EventAlert runs when a point’s alert state is triggered.

EventBeginProcessing runs at the beginning of retrieving values to be trended from the Value History Service (VHS) and updating the trend display.

EventCancel runs when the nested view is canceled and is expecting to be closed.

EventCardChange fires when the selected card is changed by user interaction or by scripted methods.

EventChange runs when the user changes a selection within the object.

EventClick runs when the user clicks the left mouse button once on the object.

EventContextMenu runs when one of the custom context menu items that is defined or overridden by this object is clicked.

EventContextMenuObjects runs when one of the custom context menu items that is defined for objects in the view (and not overridden by the active object) is clicked.

Similar to EventContextMenuObjects except EventContextMenuView handles custom context menu items from TheView’s context menu (defined in the ContextMenuView property).

In the Workspace, EventCustom runs in response to the RaiseCustomEvent and RaiseGroupCustomEvent methods of the Workspace.

In Nested Views, in addition to EventCustom on the appropriate views, this runs when the contained view has called Raise*CustomEvent. It allows TheView to handle messages from its nested views.

EventDoubleClick runs when the user clicks the left mouse button twice on the object.

EventDClick runs when the user clicks the left-mouse button twice.

EventDClickCol runs when the user clicks the left mouse button twice on the column.

EventDClickCorner runs when the user clicks the left mouse button twice on the upper lefthand cell.

EventDClickRow runs when the user clicks the left mouse button twice in the row.

Obsolete

Obsolete

Obsolete

EventEndProcessing runs at the end after processing is finished, or retrieving values to be trended from the Value History Service (VHS) and updating the trend display.

EventFilterChange is fired when the filter is changed.

EventHistoryPlaybackMode runs when the History Playback mode changes. The event parameter specifies the new mode.

EventHistoryPlaybackTime runs when the History Playback Time has changed. The event parameter is the new History Playback Time.

EventHyperLink runs anytime the contained view requests a hyperlink and uses only the basic parameters of Filepath, Site.Service, FacilityID, and Autoclose.

EventHyperLinkSys runs immediately after EventHyperLink whenever a HyperLink is requested by the Nested View and passes a string parameter of XML to TheView. HyperLinkSys uses an XML string of the following format:

All of these attributes are optional (although omitting FilePath would probably not be useful), which will result in the above values as defaults. Note that ViewGroup is ignored if NewViewGroup="true."

Only handle one of these two events. If the nested view uses HyperLinkSys, the XML string will be directly passed to EventHyperLinkSys (in which case the string may have missing or additional attributes), otherwise the event will construct an XML string with the first five parameters. It is safe to directly pass this parameter to HyperLinkSys, thus preserving the un-nested behavior of the nested screen.

EventHyperLink ignores NewViewGroup and ViewGroup, so if you want to respect the nested view’s use of these parameters (the former also being a parameter of HyperLinkEx), then EventHyperLinkSys is the preferred method.

EventInitialize runs when TheView is started in Run or Preview mode to allow further initialization for the control.

EventItemChange runs when a point property associated with the [DisplayItem] property changes.

For the Text Tool only, this event runs when manual update mode is enabled or disabled for an associated point. Manual update mode is enabled or disabled via the Manual update mode setting on the General page of the PNT editor or via the Edit Current Value dialog box for a current value service point.

EventLClick runs when the user clicks the left mouse button once.

EventLClickCol runs when the user clicks the left mouse button once on the column.

EventLClickCorner runs when the user clicks the left mouse button on the upper lefthand cell.

EventLClickRow runs when the user clicks the left mouse button once on the row.

EventMaximize is run when the user selects Maximize from the right-click menu in Run mode or calls the CxTrend.Maximize method from script. When entering maximization mode, the Maximize parameter value passed in is "True." When exiting maximization mode, the Maximize parameter value passed in is "False."

EventMouseDown runs when the user clicks a mouse button while the cursor is in the control region. See EventMouse Parameters for descriptions of parameters.

EventMouseMove runs when the user moves the mouse while the cursor is over the control region. See EventMouse Parameters for descriptions of parameters.

EventMouseUp runs when the user lifts a mouse button after having depressed it in the control region. The mouse may have been lifted outside the control region. See EventMouse Parameters for descriptions of parameters.

EventNoteCreated is run before a note is created. This event can be triggered by selecting the Add Note menu option on a trend in Run mode.

Syntax

ObjectCode_EventNoteCreated(ByRef ShowNoteEditor as Boolean, ByRef CreateNote as Boolean, ByRef Note as Note)

Parameters

• ShowNoteEditor is a modifiable Boolean that determines whether the Note Editor will be displayed (True) or not (False) for the note being created. This parameter could be used to suppress the invocation of the standard Note Editor allowing a custom Note Editor to be displayed when the event is fired.
• CreateNote is a modifiable Boolean that determines whether to create (True) the note in CygNet or not (False). Does nothing if ShowNoteEditor is set to True.
• Note is a modifiable CxNote.Note object that represents the note being created.

See also Notes.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Sub Trend1_EventNoteCreated(ShowNoteEditor, CreateNote, Note)
Dim This : Set This = Trend1
ShowNoteEditor = False
 
    Dim msg : msg = Inputbox("Enter a note summary.", "Note Creation")
     
    If msg = "" Then
        CreateNote = False
        Exit Sub
    End If
     
    note.summary = msg
    note.body = note.summary
    CreateNote = True
End Sub

EventNoteEdited is run before a note is edited. This event can be triggered by double-clicking an annotation on a trend in Run mode.

Syntax

ObjectCode_EventNoteEdited(ByRef ShowNoteEditor as Boolean, ByRef UpdateNote as Boolean, ByRef Note as Note)

Parameters

• ShowNoteEditor is a modifiable Boolean that determines whether the Note Editor will be displayed (True) or not (False) for the note being edited. This parameter could be used to suppress the invocation of the standard Note Editor allowing a custom Note Editor to be displayed when the event is fired.
• UpdateNote is a modifiable Boolean that determines whether to update (True) the note in CygNet or not (False). Does nothing if ShowNoteEditor is set to True.
• Note is a modifiable CxNote.Note object that represents the note being created.

See also Notes.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Sub Trend1_EventNoteEdited(ShowNoteEditor, UpdateNote, Note)
Dim This : Set This = Trend1
    ShowNoteEditor = False
     
    Dim msg : msg = Inputbox("Enter details to append to the note body.", "Note Edit")
    note.body = note.body + vbCrlf + msg
     
    If msg = "" Then
        UpdateNote = False
        Exit Sub
    End If
     
    UpdateNote = True
 
End Sub

EventNotesChanged is run every time the number of note labels within a Trend Tool view window changes. For example, the event fires when note labels come into scope or fall out of scope, and if the DisplayInformation property Notes option is activated or deactivated.

When a Trend Tool is used in conjunction with a Note Feed Tool, the event triggers changes in the feed that reflect the status of note labels on the trend. For example, note labels are added to or deleted from the Note Feed Tool accordingly.

Syntax

ObjectCode_EventNotesChanged()

Parameters

• This event takes no parameters.

See also Notes.

EventNoteSelected is run after a note label is selected or cleared.

Syntax

ObjectCode_EventNoteSelected(NoteTag As String, SelectState As Boolean)

Parameters

• NoteTag returns the unique identifier of the (de)selected note in the format SITE.SERVICE~NOTENUMBER. A note's database key with no preceding zeroes makes up NOTENUMBER.

• SelectState returns a value that indicates that a note label was selected (True) or cleared (False). Both parameters are required.

See also Notes.

EventOnBeforeNewOPCData runs before data from an attached OPC server is sent to the object control. The EventOnBeforeNewOPCData will fire everything when OPC data is received by the object, regardless of whether the data is different than previously received.

EventOnButtonCLick is fired when a button in the first button column is pressed, if the button is configured to do so, and if the event is scripted to do so. See Button First Column for more information.

EventOnChange runs when the Active property changes.

EventOnChangeUser runs when the Active property changes from user interaction with the control.

EventOnClick runs when the user presses a key while the control has the keyboard focus.

EventOnClickPointer runs when the Pointer is clicked with the mouse. Use OnClickPointer to specify actions to perform when the pointer is clicked.

EventOnCurrentMaxChange runs when the CurrentMax value changes.

EventOnCurrentMinChange runs when the CurrentMin value changes.

EventOnCustomizeTickLabel runs before each major tick label is painted and allows for the label to be modified.

EventOnDblClick runs when the application end-user double-clicks on an individual object.

EventOnKeyDown runs when the user presses a key while the control has the keyboard focus.

EventOnKeyPress runs when the user presses a single key while the control has the keyboard focus.

EventOnKeyUp runs when the user releases a key while the control has the keyboard focus.

EventOnMouseDown runs when the user presses a mouse button.

EventOnMouseMove runs when the user moves the mouse over the object.

EventOnMouseUp runs when the user releases a key while the control has the keyboard focus

EventOnNewOPCData runs when data from an attached OPC server is sent to the object control.

EventOnPositionChange runs when the Position property changes.

EventOnPositionChangeFinished runs when the user changes a Position property value by left clicking and releasing the mouse button.

EventOnPositionChangeUser runs when the Position value changes due to user interaction with the control.

EventOnPositionOverLimit runs when the Position property changes to a value greater than an upper bound limit.

EventOnPositionOverMax runs when the Position property changes to a value greater than the CurrentMax property value.

EventOnPositionUnderLimit runs when the Position property changes to a value less than an upper bound limit.

EventOnPositionUnderMin runs when the Position property changes to a value less than the CurrentMin property value.

EventOnSecondButtonClick is fired when a button in the last button column is pressed, if the button is configured to do so, and if the event is scripted to do so. See Button Last Column for more information.

EventOnSelChange runs whenever a user changes the selected node in the tree. Also see OnSelChange.

EventOnSelChangeLevel runs when a user changes the current selection in the navigation bar. EventOnSelChangeLevel will trigger whenever SelPrev, NavPrev, SelNext or NavNext are called. See Facility Navigation Bar Tool Methods and Group Navigation Bar Tool Methods.

Also see Synchronizing the View with a Group Navigation Bar for more information about this event.

EventOnStatusValueChange runs when the monitored status point’s value changes. This will only run if a status point is configured.

EventOnTab is fired when the tab key is pressed.

EventOnValueChange runs when the Value property changes.

EventPointChange runs when an unrelated point is updated. This event can significantly reduce initialization time for screens that may contain objects configured for unrelated points. Unrelated points can be registered using an object’s RegisterPointForChangeNotice method, if applicable.

EventPostSetPoint runs directly after the SetPoint operation completes. This event runs whether or not the SetPoint operation completed successfully.

This event has two parameters: ErrorCode and ErrorMessage. If the ErrorCode is 0, then the SetPoint operation was successful.

EventPreSetPoint runs directly before the SetPoint operation.

EventPreToolTip gives a script writer an opportunity to create a custom tooltip via script just before the tooltip is shown, when it is needed, and not during screen initialization, which can reduce loading time.

Example

1
2
3
4
Sub TextTool1_EventPreToolTip()
    Dim This : Set This = TextTool1
    This.ToolTipText = The tooltip text()
End Sub

EventPumpData is a legacy event, and is effectively obsolete. Do not use.

In the past, this event would run when data was "pumped" to TheView.

EventRClick runs when the user clicks the right mouse button once.

EventRClickCol runs when the user clicks the right mouse button once on the column.

EventRClickCorner runs when the user clicks the right mouse button once on the corner.

EventRClickRow runs when the user clicks the right mouse button once on the row.

EventRefresh runs when the screen is refreshed.

EventRefreshComplete runs when the screen refresh is complete.

EventRefreshTargetData runs when the target level data is refreshed.

EventResize runs while TheFrame is being resized, so users can implement more advanced sizing code than the FlexHorizontal and FlexVertical constraints allow.

EventRestarted runs when TheView is started after having been restarted using the Restart() method. See Event Execution Order.

EventRestarting runs when TheView is starting after having been restarted using the Restart() method. See Event Execution Order.

EventRowButtonClicked runs when the user clicks the button on the row once.

EventRowChange runs when the user moves the selection between rows.

EventScroll runs after scrolling TheView, so users can implement custom scrolling behavior.

The EventSharedMessageReceived event on TheFrame/TheView can receive a message sent from another instance of CygNet Studio or CygNet Vision by the SendSharedMessage method of TheView.

Example

1
2
3
4
5
6
7
Sub TheView_EventSharedMessageReceived(MessageID, Data)
    ' receive message
    Dim This : Set This = TheView
    If MessageID = "CHANGE_LEVEL1_FACILITY" Then
        TheView.Facility = Data
    End If
End Sub

EventServiceStatusChange is fired when the service status changes.

EventSelChange runs whenever a selection in the grid changes.

EventShowTrend runs when the Trend option is selected from the right-click context menu. Script must specify whether to open a single point trend in a new window or populate a trend control on the screen.

EventTerminate runs when TheView is being closed, either manually by the user or using the Cancel() method.

EventTimer runs at every timer interval, which is set using TheView’s [TimerInterval] property. The default interval is 0 milliseconds, which disables the timer. Runs when the user selects the associated option from the Context menu on the WatchList.

EventTrendAddTag runs when a user adds a point to a single-point trend.

EventTrendRemoveTag runs when a user removes a point from a single-point trend.

EventTrendSingleTag runs when a user starts a single point trend.

EventTrendSingleTagRollup runs when a user starts a rollup trend for a single point.

EventVersionNotify runs when a .csf file loaded from a Blob service is out-of-date compared to the version on the Blob. See Setting Periodic Version Checks for more information about this event.

EventViewableAlarmsChange is fired when there is a change in the viewable alarms.

EventZoom runs when the user left-clicks on a trend and continues to hold down the mouse button while drawing a zoom area.