ExternalWindowObserver Class |
Integrates a window outside of the desktop for interaction and control with the API.
Inheritance HierarchyNamespace: Openfin.Desktop
Assembly: OpenfinDesktop (in OpenfinDesktop.dll) Version: 17.4.0
SyntaxC#
public sealed class ExternalWindowObserver : IDisposable, DesktopStateListener
The ExternalWindowObserver type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ExternalWindowObserver(Runtime, String, String, IntPtr) |
Establishes a connection and registers
the window identified by hWnd with the desktop.
|
| ExternalWindowObserver(String, Int32, String, String, IntPtr) |
Establishes a connection and registers
the window identified by hWnd with the desktop.
|
Properties| Name | Description | |
|---|---|---|
 | Name |
The Name property represents the name for the window which
must be unique within the context of the invoking Application.
|
| UUID |
The UUID property represents the UUID of
the application this window is a child of.
|
Methods| Name | Description | |
|---|---|---|
| Dispose |
Ensures this window is deregistered on disposal.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| onClosed |
Callback when the connection with the Desktop has closed.
|
| onError |
Callback when client cannot start or connect to the Desktop.
|
| onMessage |
Callback when a message is sent to this client.
|
| onOutgoingMessage |
Callback when a message is sent from this client.
|
| onReady |
Callback when Desktop is successfully connected and ready to
accept commands.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
An integrated window is controlled in the same way as an HTML window running in the desktop.
It can be controlled and queried by the API,
generate events that are subscribed to by addEventListener,
and join/merge groups with other windows for docking.
See Also