AX2696

Process Action Codes command

Use the Process Action Codes command to process action codes on a sheet. You can process all unnamed action codes, or you can process a single named action code.

This command provides a way to process action codes "on demand," regardless of whether Axiom queries or calc methods are used in the sheet.

Can be used in

Axiom forms
Ribbon tabs
Task panes

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

Shortcut parameters

This command uses the following shortcut parameters:

Parameter Description

Sheet Name

Parameter	Description
Sheet Name	The sheet for which to process action codes. If left blank, the current sheet will be processed. This setting is required when using the command in Axiom forms. When the file is rendered as an Axiom form there is no concept of a "current sheet," therefore you must specify the sheet to process.
Action Codes Tag Name	Optional. The name of the ActionCodes tag that you want to process. To use this option, the sheet must contain an ActionCodes tag with a matching name. For example, if you enter `MyName`, then the sheet must contain a tag as follows: `[ActionCodes:MyName]`. The processing behavior is as follows: If a tag name is specified, then only the action codes defined in that tag's control row and control column will be processed. If the sheet contains other ActionCode tags (named or not), they will be ignored. If no tag name is specified, then all action codes will be processed except those belonging to named ActionCodes tags.
Processing Step	Specifies when the command will be executed during the form update process. This option only applies when using the command in an Axiom form. By default, this is set to Form - After AQ Refresh, which means that the command will be performed on the Axiom form source file, after Axiom queries have been refreshed. If desired, you can specify a different processing step for the command, including choosing to execute the command on the active client spreadsheet rather than the form (when using the form as a dialog or task pane in the Excel Client or Windows Client). For more information, see Timing of command execution and Axiom form update process.

The sheet for which to process action codes. If left blank, the current sheet will be processed.

This setting is required when using the command in Axiom forms. When the file is rendered as an Axiom form there is no concept of a "current sheet," therefore you must specify the sheet to process.

Action Codes Tag Name

Optional. The name of the ActionCodes tag that you want to process.

To use this option, the sheet must contain an ActionCodes tag with a matching name. For example, if you enter MyName, then the sheet must contain a tag as follows: [ActionCodes:MyName].

The processing behavior is as follows:

If a tag name is specified, then only the action codes defined in that tag's control row and control column will be processed. If the sheet contains other ActionCode tags (named or not), they will be ignored.
If no tag name is specified, then all action codes will be processed except those belonging to named ActionCodes tags.

Processing Step

Specifies when the command will be executed during the form update process. This option only applies when using the command in an Axiom form.

By default, this is set to Form - After AQ Refresh, which means that the command will be performed on the Axiom form source file, after Axiom queries have been refreshed.

If desired, you can specify a different processing step for the command, including choosing to execute the command on the active client spreadsheet rather than the form (when using the form as a dialog or task pane in the Excel Client or Windows Client). For more information, see Timing of command execution and Axiom form update process.

Visibility

In task panes and ribbon tabs, items that use this command are only visible if the current document contains action codes. 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. No message is displayed to the user regarding the action code processing, regardless of whether it was successful or failed (meaning no action codes were found).

Remarks

For more information on using this command in an Axiom form, see Processing action codes in an Axiom form.