IRemoteDesktopClientEvents interface

  • Article

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Defines the event handler methods for the Remote Desktop Protocol (RDP) app container client control.

Members

The IRemoteDesktopClientEvents interface inherits from the IDispatch interface. IRemoteDesktopClientEvents also has these types of members:

  • Methods

Methods

The IRemoteDesktopClientEvents interface has these methods.

Method Description
OnAdminMessageReceived

Called when the client control receives an administrative message.
OnAutoReconnected

Called when the client control has automatically reconnected to a remote session.
OnAutoReconnecting

Called when the client control attempts to automatically reestablish a connection to a remote session.
OnConnected

Called when the client control has connected to a remote session.
OnConnecting

Called when the client control attempts to establish a connection to a remote session.
OnDialogDismissed

Called after a dialog box displayed by the client control is dismissed.
OnDialogDisplaying

Called before the control displays a dialog box.
OnDisconnected

Called when the client control has been disconnected from a remote session.
OnKeyCombinationPressed

Called when special key combinations are pressed in the remote session.
OnLoginCompleted

Called when the client control has successfully logged on to a remote session.
OnNetworkBandwidthChanged

Called when the network bandwidth has changed.
OnRemoteDesktopSizeChanged

Called when the remote desktop size has changed.
OnStatusChanged

Called when the client control has updated its status.

 

Examples

The following JavaScript code example shows how to add an event handler.

function MyOnNetworkBandwidthChanged(qualityLevel, bandwidth, latency)
{
    var level = qualityLevel;
}

function SetOnNetworkBandwidthChangedEvent(rdpControl)
{
    rdpControl.attachEvent("OnNetworkBandwidthChanged", MyOnNetworkBandwidthChanged);
}

Requirements

Minimum supported client

 Windows 8 Consumer Preview

Minimum supported server

 Windows Server 8 Beta

IID

IID_IRemoteDesktopClientEvents is defined as 079863B7-6D47-4105-8BFE-0CDCB360E67D

 

 

Send comments about this topic to Microsoft

Build date: 4/21/2012