AX2714

Refresh Axiom Queries command

Use the Refresh Axiom Queries command to refresh the currently active file. You can use the shortcut parameters to specify different refresh modes.

Can be used in

Axiom forms (only when form is used as a dialog or task pane in the Desktop Client)
Ribbon tabs
Task panes

This command is included in the default AxiomDesigner.AXL ribbon tab, and in the default AxiomMain.AXL ribbon tab (File Options group).

When the RefreshAxiomQueries command is selected from the Command Library as the shortcut target, it displays as command://RefreshAxiomQueries or command://RefreshAxiomQueriesCommandAdapter (legacy syntax).

Shortcut parameters

This command uses the following shortcut parameters:

Item	Description
Refresh Mode	Select one of the following: Refresh Workbook (default): Refreshes all Axiom queries in the active workbook. Refresh Active Sheet: Refreshes Axiom queries in the currently active sheet. Refresh Axiom Query: Displays a menu of all Axiom queries in the active workbook (by sheet), so that you can selectively refresh a single query. This option is not available in Axiom forms. Refresh Formulas: Refreshes formulas only; Axiom queries are not run. For all modes that include refreshing Axiom queries, the queries are only run if they are active and if Refresh on manual refresh is enabled.
Enable iterative calculation	Selecting this option enables iterative calculations for the refresh process. The iterative calculation settings are fixed at a maximum of 100 iterations and a maximum change value of .001. For more information on iterative calculations, see the Microsoft Excel Help. By default this option is not selected. It is recommended to leave this option disabled unless you have a file that you know requires iterative calculations.
Processing Step	Specifies when the command will be executed during the Axiom form update process. This option is set to Active Client Spreadsheet - After Processing and cannot be changed. This option only applies when using the command in an Axiom form. For more information, see Timing of command execution and Axiom form update process.

Item

Description

Refresh Mode

Select one of the following:

Refresh Workbook (default): Refreshes all Axiom queries in the active workbook.
Refresh Active Sheet: Refreshes Axiom queries in the currently active sheet.
Refresh Axiom Query: Displays a menu of all Axiom queries in the active workbook (by sheet), so that you can selectively refresh a single query. This option is not available in Axiom forms.
Refresh Formulas: Refreshes formulas only; Axiom queries are not run.

For all modes that include refreshing Axiom queries, the queries are only run if they are active and if Refresh on manual refresh is enabled.

Enable iterative calculation

Selecting this option enables iterative calculations for the refresh process. The iterative calculation settings are fixed at a maximum of 100 iterations and a maximum change value of .001. For more information on iterative calculations, see the Microsoft Excel Help.

By default this option is not selected. It is recommended to leave this option disabled unless you have a file that you know requires iterative calculations.

Processing Step

Specifies when the command will be executed during the Axiom form update process. This option is set to Active Client Spreadsheet - After Processing and cannot be changed. This option only applies when using the command in an Axiom form.

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

Visibility

In task panes and ribbon tabs, items using this command are visible if the currently active file is a spreadsheet file, and if the ability to refresh Axiom queries is allowed for that file type. For plan files, only administrators and users with the Run Axiom Queries security permission can refresh Axiom queries. Other Axiom file types do not have restrictions on the ability to refresh Axiom queries.

You can use the Show restricted items option in the task pane or the ribbon tab to force items that use this command to be visible at all times (but grayed out if unavailable).

In Axiom forms, the command used does not impact whether the button is visible or enabled. If the refresh cannot be run (for example if the active client spreadsheet is a plan file and the user does not have the appropriate permissions) then no action occurs and no error displays to the user.

Remarks

In Axiom forms, this command is only valid when the form is designed to be used as a dialog or task pane in the Windows Client or the Excel Client. For more information, see Using Axiom forms as custom dialogs and task panes in the Desktop Client. The command does not execute Axiom queries in the form source file itself.