CloseSynchron Method (IMoveable)

Class

IMoveable.

Action

Closes the window and waits until the window is closed.

The method attempts to close the window by trying the following events, in this sequence, stopping when the window closes:
  1. Call the close() method on the window.
  2. If the window is a dialog, type the keys specified in the option OPT_CLOSE_DIALOG_KEYS and wait one second for the dialog to close.
  3. If there is a single button in the window, click that button.
  4. If the closeConfirm parameter is set to true: Click the list of buttons specified with the option OPT_CLOSE_WINDOW_BUTTONS.
  5. Select the menus specified with option OPT_CLOSE_WINDOW_MENUS.
  6. Use Alt+F4.

This method supports several specifications you can make to help the Open Agent closes a window. You can make these specification by use Desktop.setOption(String, Object) to set the appropriate values for the mentioned options. For example, if closing the window opens a confirmation dialog with a button that contains the text "Do not save" use:

desktop.setOption(CommonOptions.OPT_CLOSE_CONFIRM_BUTTONS, Arrays.asList("Do not save"));

Close may fail. For example, if closing a window causes the application to display a message box and closeConfirm is set to false, or if the buttons used to close the message box are not covered under the OPT_CLOSE_CONFIRM_BUTTONS option, the call will fail and raise a CloseFailedException.

Syntax

C#
iMoveable.CloseSynchron([closeConfirm])
VB
iMoveable.CloseSynchron([closeConfirm])
Variable Description
closeConfirm Optional: Specifies whether to close confirmation dialogs that may pop up when closing the window, for example a 'Save changes' dialog. Use true to close confirmation dialogs and false to raise an exception if a confirmation dialog pops up. If set to true the value of the option OPT_CLOSE_CONFIRM_BUTTONS is used to determine which button to select in order to close confirmation dialogs. Boolean.