DesktopSystemgetAllWindows Method |
Retrieves an array of data (name, ids, bounds) for all application windows.
Requires administrator privileges.
Namespace: Openfin.Desktop
Assembly: OpenfinDesktop (in OpenfinDesktop.dll) Version: 14.1.0-alpha3
SyntaxC#
public void getAllWindows( AckCallback callback, AckCallback errorCallback = null )
Parameters
- callback
- Type: Openfin.DesktopAckCallback
A function that is called and passed an array containing the window information. - errorCallback (Optional)
- Type: Openfin.DesktopAckCallback
(Optional) A function that is called if the method fails. The reason for failure is passed as an argument.
Remarks
The object passed to callback takes the form:
[
{
uuid: (string) uuid of the application,
mainWindow: {
name: (string) name of the main window,
top: (integer) top-most coordinate of the main window,
right: (integer) right-most coordinate of the main window,
bottom: (integer) bottom-most coordinate of the main window,
left: (integer) left-most coordinate of the main window
},
childWindows: [{
name: (string) name of the child window,
top: (integer) top-most coordinate of the child window,
right: (integer) right-most coordinate of the child window,
bottom: (integer) bottom-most coordinate of the child window,
left: (integer) left-most coordinate of the child window
},
...
]
},
...
]
See Also