The IConnection Interface exposes the events listed in the following table:
| Events | Description |
|---|---|
| Gets triggered when a language change occurs in the runtime system. | |
| Gets triggered when you have switched to another system (Switch to). | |
| Gets triggered when the runtime system performs a Switch to another system. | |
| Gets triggered when the runtime system closes a session with the client. | |
| Gets triggered when the state of the connection progress changes. | |
| Gets triggered when the required assemblies for a client session is downloaded successfully. | |
| Gets triggered when the runtime system detects that the user requesting a session is already logged into the system. | |
| Gets triggered when a change occurs in the Busy state for a connection. | |
| Gets triggered when the runtime system returns error messages to a client session. | |
| Gets triggered when the runtime system sets the focus on a field in the current DataModel. | |
| Gets triggered when the runtime system requests the view to display a teach class. | |
| Gets triggered when the status information is updated by the runtime system. | |
| Gets triggered when the response from the runtime system requires a different DataModel to be used, instead of the current DataModel. |
Each event typically includes a related EventArgs object containing event arguments to provide information about the event. The following topics list the possible event argument types and their descriptions.
ConnectionEventArgs
The ConnectionEventArgs class is used to convey information to a caller registered to receive one of the following events:
SetCursorRequest (notification about the field that has gained focus)
ChangeLocaleRequest (notification about a language change)
TransmissionObjectChanged (notification about a different ispec returned from the runtime system)
An instance of this class is returned to the EventHandler with the relevant information.
The ConnectionEventArgs class contains the following properties:
| Properties | Description |
|---|---|
| TransmissionObject TransObject | The current TransmissionObject held by the Connector. |
| string FocusField | The field in the DataModel that has been given the focus by the runtime system. |
| int ColumnIndex | The Copy Index when the FocusField is part of a CopyFrom region. This specifies the index of the list item in the collection returned for a Copy.From set. |
InformationEventArgs
The InformationEventArgs class is used to convey information to a caller registered to receive the ConnectionProgressStatus event.
An instance of this class is returned to the EventHandler with the relevant information.
The InformationEventArgs class contains the following properties:
| Properties | Description |
|---|---|
| InformationType Information | This property contains information about the ConnectionEventArgs event. It is an instance of the InformationType enumeration that can contain one of the following values: 0 – Connected. The client session is connected to the host system. 1 – Connecting. The client session is in the process of connecting to the host system. 2 – ConnectionFailed. The client session failed to connect to the host system. 3 – InputValidationError. The data sent from the client is invalid according to the DataModel definition. |
| string [] Info | A collection of string containing the host or system name. |
ConnectionCloseRequestArgs
The ConnectionCloseRequestArgs class is used to convey information to a caller registered to receive the CloseRequest event.
An instance of this class is returned to the EventHandler with the relevant information.
The ConnectionCloseRequestArgs class contains the following property:
| Properties | Description |
|---|---|
| bool ForcedClosure | This property is set to true when the host system has closed the connection. |
ShowClassRecallScreenEventArgs
The ShowClassRecallScreenEventArgs class is used to convey information to a caller registered to receive the ShowTeachRequest event.
An instance of this class is returned to the EventHandler with the relevant information.
The ShowClassRecallScreenEventArgs class contains the following properties:
| Properties | Description |
|---|---|
| string Owner | The ispec or class name that owns the Teach screen. |
| string Name | The name of the Teach screen. |
ConnectionDownloadCompleteEventArgs
The ConnectionDownLoadCompleteEventArgs class is used to convey information to a caller registered to receive the DownLoadComplete event.
An instance of this class is returned to the EventHandler with the relevant information.
The ConnectionDownloadCompleteEventArgs class contains the following property:
| Properties | Description |
|---|---|
| string Path | The location of the downloaded files. |
ConnectionChangeSystemRequestCancelEventArgs
The ConnectionChangeSystemRequestCancelEventArgs class is used to convey information to a caller registered to receive the ChangeSystemRequest event.
An instance of this class is returned to the EventHandler with the relevant information.
The ConnectionChangeSystemRequestCancelEventArgs class contains the following properties:
| Properties | Description |
|---|---|
| string Name | The name of the system being switched to. |
| string Host | The domain name or IP address of the machine where the host system is running. |
| string StationName | The station name to be used while connecting to the system. |
| string DownloadURI | The location from where the required assemblies can be downloaded. |
| IEnumerable<string> DownloadFiles | A comma separated list of assemblies that has to be downloaded. |
| bool IsAnonymous | Specifies whether the connection to the host system uses anonymous access. |
| bool ForceLogin | Specifies whether the connection overrides any previous login for a specified user. |
| bool ConnectToDebugger | Specifies whether the system being switched to is connecting to a Debugger session. |
TransactionErrorsArgs
The TransactionErrorsArgs class is used to convey information to a caller registered to receive the ProcessTransactionErrors event.
An instance of this class is returned to the EventHandler with the relevant information.
The TransactionErrorsArgs class contains the following properties:
| Properties | Description |
|---|---|
| bool ShowDialog | Specifies whether an Error dialog box should appear. This is set to True when multiple errors are returned. |
| IEnumerable<string> Errors | A list of errors returned from the runtime system. |