Application Class |
An object representing the Application.
Allows the developer to execute, show and close an application, as well as show and hide an icon on Desktop. Also provides access to the Window object for the main application window to control window state such as the ability to minimize, maximize, restore, etc.
Inheritance HierarchyNamespace: Openfin.Desktop
Assembly: OpenfinDesktop (in OpenfinDesktop.dll) Version: 17.5.1
SyntaxC#
public sealed class Application : IOpenfinEntity, IDisposable
The Application type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Application(String, DesktopConnection) | Obsolete.
Attaches an Application object to an application that already exists.
|
| Application(ApplicationOptions, DesktopConnection, AckCallback, AckCallback) | Obsolete.
Application Constructor.
|
Properties| Name | Description | |
|---|---|---|
 | DesktopConnection | Obsolete. |
| Runtime |
Gets the Runtime that created the Application.
|
| Uuid |
Gets the UUID of the Application.
|
Methods| Name | Description | |
|---|---|---|
| addEventListener | Obsolete.
Registers an event listener on the specified event.
|
| close |
Closes the application
|
| createChildWindow |
Create a child window
|
| Dispose |
Dispose the current application instance.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| getChildWindows |
Passes a list of wrapped child windows for the current application to childHandler.
|
| GetChildWindowsAsync |
Passes a list of wrapped child windows for the current application to childHandler.
|
| getGroups | Obsolete.
Passes a list of groups and their wrapped child windows
for the current application to groupHandler.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| getInfo |
Retrieves information about the application
|
| getManifest |
Retrieves the JSON manifest that was used to create the application.
Invokes the error callback if the application was not created from a manifest.
|
| getOptions | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| getUuid | |
| getWindow | |
| isRunning |
Determines if the application is currently running/active.
|
| pingChildWindow |
Pings a child window
|
| removeEventListener | Obsolete.
Removes a previously registered event listener from the specified event.
The listener is passed an event object containing information related to the event. |
| restart |
Restart the application.
|
| run | Obsolete.
Runs the application on the AppDesktop.
|
| Run | Obsolete.
Run the application if it is not already running and perform the specified action after the application is connected.
This action is invoked in two conditions:
1) The application was not previously running and now is.
2) The application was previously launched by the.NET Adapter.
|
| Start |
Starts running the application on the AppDesktop. It is advised to check if the application is already running
by calling isRunning before invoking this method.
|
| terminate |
Terminates the application.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| waitFor |
Wait for the application if it is unresponsive.
|
 | wrap | Obsolete.
Attaches an Application object to an application that already exists.
|
| WrapView |
Wraps an existing platform view using the specified name.
|
| WrapWindow |
Wraps an existing window using the specified name.
|
Events| Name | Description | |
|---|---|---|
 | Closed |
Occurs when the application is closed.
|
| Connected |
Occurs when the application has authenticated and is connected.
|
| Crashed |
Occurs when the application crashes.
|
| Error |
Occurs when the application has an error.
|
| Initialized |
Occurs when the application main window has initialized.
|
| ManifestChanged |
Occurs when a manifest has been changed.
|
| NotResponding |
Occurs when the application is not responding.
|
| OutOfMemory |
Occurs when the application is out of memory.
|
| PlatformViewCreated |
Occurs when a platform view is created.
Contains information
|
| Responding |
Occurs when the application is responding following a not responding event.
|
| RunRequested |
Occurs when the application has been requested to run.
|
| Started |
Occurs when the application has started.
|
| TrayIconClicked |
Occurs when a try icon has been clicked.
|
| WindowAlertRequested |
Occurs when a window is requesting to show an alert.
|
| WindowAuthenticationRequested |
Occurs when a window has requested authentication credentials.
|
| WindowBlurred |
Occurs when a window loses its focus.
|
| WindowClosed |
Occurs when the application has closed a window.
|
| WindowClosing |
Occurs when a child window has initiated the closing routine.
|
| WindowCrashed |
Occurs when a window has crashed.
|
| WindowCreated |
Occurs when the application has created a window.
|
| WindowEmbedded |
Occurs when the window has been embedded
|
| WindowEndLoaded |
Occurs when a window ended loading.
|
| WindowExternalProcessExited |
Occurs when the external process has exited.
|
| WindowExternalProcessStarted |
Occurs when the external process has started.
|
| WindowFileDownloadCompleted |
Occurs when a file download has completed.
|
| WindowFileDownloadProgress |
Occurs during file download progress.
|
| WindowFileDownloadStarted |
Occurs when a file download has started.
|
| WindowFocused |
Occurs when a window of the application gains focus.
|
| WindowFrameDisabled |
Occurs when a widnows frame becomes disabled.
|
| WindowFrameEnabled |
Occurs when a window frame becomes enabled
|
| WindowGroupChanged |
Occurs when a window joins/leaves a group and/or when the group a window is a member of changes.
|
| WindowHidden |
Occurs when a window has been hidden.
|
| WindowInitialized |
Occurs when a window is initialized.
|
| WindowMaximized |
Occurs when a window is maximized.
|
| WindowMinimized |
Occurs when a window is minimized.
|
| WindowNavigationRejected |
Occurs when the application main window navigation was rejected.
|
| WindowNotResponding |
Occurs when a window is not responding.
|
| WindowOutOfMemory |
Occurs when a process ran out of memory.
|
| WindowPreloadScriptsStateChanged |
Occurs after the execution of all of a window's preload scripts.
Contains information about all window's preload scripts' final states.
|
| WindowPreloadScriptsStateChanging |
Occurs during the execution of a window's preload script.
Contains information about a single window's preload script's state, for which the event has been raised.
|
| WindowReloaded |
Occurs when a window was reloaded.
|
| WindowResponding |
Occurs when a window is responding following a not responding event.
|
| WindowRestored |
Occurs when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
| WindowShown |
Occurs when a hidden window has been shown.
|
| WindowShowRequested |
Occurs when a window is requesting to be shown.
|
| WindowStartLoad |
Occurs when a window started loading.
|
See Also