UI.Dialog object

The object that is returned when the displayDialogAsync method is called.

Members

Member Type Description
close Function Allows the add-in to close its dialog box.
addEventHandler Function Registers an event handler. The two supported events are:
  • DialogMessageReceived. Triggered when the dialog box sends a message to its parent.
  • DialogEventReceived. Triggered when the dialog box has been closed or otherwise unloaded.

close()

Called from a parent page to close the corresponding dialog box.

[dialogObject].close();    

Parameters

None.

Returns

void

Examples

For examples, see the DisplayDialogAsync method topic.