Click or drag to resize

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 Hierarchy
SystemObject
  Openfin.DesktopApplication

Namespace:  Openfin.Desktop
Assembly:  OpenfinDesktop (in OpenfinDesktop.dll) Version: 17.6.0
Syntax
C#
public sealed class Application : IOpenfinEntity, 
	IDisposable

The Application type exposes the following members.

Constructors
  NameDescription
Public methodApplication(String, DesktopConnection) Obsolete.
Attaches an Application object to an application that already exists.
Public methodApplication(ApplicationOptions, DesktopConnection, AckCallback, AckCallback) Obsolete.
Application Constructor.
Top
Properties
  NameDescription
Public propertyDesktopConnection Obsolete.
Public propertyRuntime
Gets the Runtime that created the Application.
Public propertyUuid
Gets the UUID of the Application.
Top
Methods
  NameDescription
Public methodaddEventListener Obsolete.
Registers an event listener on the specified event.
Public methodclose
Closes the application
Public methodcreateChildWindow
Create a child window
Public methodDispose
Dispose the current application instance.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodgetChildWindows
Passes a list of wrapped child windows for the current application to childHandler.
Public methodGetChildWindowsAsync
Passes a list of wrapped child windows for the current application to childHandler.
Public methodgetGroups Obsolete.
Passes a list of groups and their wrapped child windows for the current application to groupHandler.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodgetInfo
Retrieves information about the application
Public methodgetManifest
Retrieves the JSON manifest that was used to create the application. Invokes the error callback if the application was not created from a manifest.
Public methodgetOptions
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodgetUuid
Public methodgetWindow
Public methodisRunning
Determines if the application is currently running/active.
Public methodpingChildWindow
Pings a child window
Public methodremoveEventListener Obsolete.
Removes a previously registered event listener from the specified event.

The listener is passed an event object containing information related to the event.

Public methodrestart
Restart the application.
Public methodrun Obsolete.
Runs the application on the AppDesktop.
Public methodRun 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.
Public methodStart
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.
Public methodterminate
Terminates the application.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodwaitFor
Wait for the application if it is unresponsive.
Public methodStatic memberwrap Obsolete.
Attaches an Application object to an application that already exists.
Public methodWrapView
Wraps an existing platform view using the specified name.
Public methodWrapWindow
Wraps an existing window using the specified name.
Top
Events
  NameDescription
Public eventClosed
Occurs when the application is closed.
Public eventConnected
Occurs when the application has authenticated and is connected.
Public eventCrashed
Occurs when the application crashes.
Public eventError
Occurs when the application has an error.
Public eventInitialized
Occurs when the application main window has initialized.
Public eventManifestChanged
Occurs when a manifest has been changed.
Public eventNotResponding
Occurs when the application is not responding.
Public eventOutOfMemory
Occurs when the application is out of memory.
Public eventPlatformViewCreated
Occurs when a platform view is created. Contains information
Public eventResponding
Occurs when the application is responding following a not responding event.
Public eventRunRequested
Occurs when the application has been requested to run.
Public eventStarted
Occurs when the application has started.
Public eventTrayIconClicked
Occurs when a try icon has been clicked.
Public eventWindowAlertRequested
Occurs when a window is requesting to show an alert.
Public eventWindowAuthenticationRequested
Occurs when a window has requested authentication credentials.
Public eventWindowBlurred
Occurs when a window loses its focus.
Public eventWindowClosed
Occurs when the application has closed a window.
Public eventWindowClosing
Occurs when a child window has initiated the closing routine.
Public eventWindowCrashed
Occurs when a window has crashed.
Public eventWindowCreated
Occurs when the application has created a window.
Public eventWindowEmbedded
Occurs when the window has been embedded
Public eventWindowEndLoaded
Occurs when a window ended loading.
Public eventWindowExternalProcessExited
Occurs when the external process has exited.
Public eventWindowExternalProcessStarted
Occurs when the external process has started.
Public eventWindowFileDownloadCompleted
Occurs when a file download has completed.
Public eventWindowFileDownloadProgress
Occurs during file download progress.
Public eventWindowFileDownloadStarted
Occurs when a file download has started.
Public eventWindowFocused
Occurs when a window of the application gains focus.
Public eventWindowFrameDisabled
Occurs when a widnows frame becomes disabled.
Public eventWindowFrameEnabled
Occurs when a window frame becomes enabled
Public eventWindowGroupChanged
Occurs when a window joins/leaves a group and/or when the group a window is a member of changes.
Public eventWindowHidden
Occurs when a window has been hidden.
Public eventWindowInitialized
Occurs when a window is initialized.
Public eventWindowMaximized
Occurs when a window is maximized.
Public eventWindowMinimized
Occurs when a window is minimized.
Public eventWindowNavigationRejected
Occurs when the application main window navigation was rejected.
Public eventWindowNotResponding
Occurs when a window is not responding.
Public eventWindowOutOfMemory
Occurs when a process ran out of memory.
Public eventWindowPreloadScriptsStateChanged
Occurs after the execution of all of a window's preload scripts. Contains information about all window's preload scripts' final states.
Public eventWindowPreloadScriptsStateChanging
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.
Public eventWindowReloaded
Occurs when a window was reloaded.
Public eventWindowResponding
Occurs when a window is responding following a not responding event.
Public eventWindowRestored
Occurs when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
Public eventWindowShown
Occurs when a hidden window has been shown.
Public eventWindowShowRequested
Occurs when a window is requesting to be shown.
Public eventWindowStartLoad
Occurs when a window started loading.
Top
See Also