AX1377

Close Dialog command

Use the Close Dialog command to close a custom Axiom form dialog that is open in the Desktop Client (Excel Client or Windows Client).

For example, when an Axiom form is being used as an Add File Form or as a RefreshDialog refresh form in the Desktop Client, this command is placed on form buttons to close the dialog.

Can be used in

Axiom forms

When the Close Dialog command is selected from the Command Library as the shortcut target, it displays as command://CloseDialog or command://CloseDialogCommandAdapter (legacy syntax).

Shortcut parameters

This command uses a single shortcut parameter:

Item	Description
Processing Step	Select one of the following to determine when the command is executed: Active Client Spreadsheet - Before Processing—This option is equivalent to clicking Cancel to close the dialog without performing any action. The dialog is closed and the form update process does not occur. Active Client Spreadsheet - After Processing—This option is equivalent to clicking OK to perform an action and then close the dialog. The full Axiom form update process occurs, and then the dialog is closed. For more information, see Timing of command execution and Axiom form update process.

Item

Description

Processing Step

Select one of the following to determine when the command is executed:

Active Client Spreadsheet - Before Processing—This option is equivalent to clicking Cancel to close the dialog without performing any action. The dialog is closed and the form update process does not occur.
Active Client Spreadsheet - After Processing—This option is equivalent to clicking OK to perform an action and then close the dialog. The full Axiom form update process occurs, and then the dialog is closed.

For more information, see Timing of command execution and Axiom form update process.

Visibility

Button components using this command are always visible and available for use, unless the button is explicitly disabled using the Enabled property.

Remarks

For more information on using this command with Axiom form dialogs, see Configuring close options for a form dialog.
This command does not apply to Dialog Panels in Axiom forms. To configure a button to close a Dialog Panel, use the Dialog Panel Action behavior and select Close as the action.