AX2297

Defining the ActionCodes tag

In order to use action code processing, you must place an ActionCodes primary tag within the sheet. Within the ActionCodes control row and control column, you can define copy, lock, and unlock actions.

To define the location of the control row and control column for action code processing, place the following tag in any cell in the sheet, within the first 500 rows:

[ActionCodes]

The column that contains the tag becomes the control column, and the row that contains the tag becomes the control row. Action tags can be placed anywhere in relation to this tag, within the control row and control column. For example, control row codes can be placed to the right or to the left of the ActionCodes tag, and control column codes can be placed underneath or above the ActionCodes tag.

The control row and control column can contain other information that does not pertain to the action codes; they do not have to be reserved for action codes only. The action code processing will ignore any content in the control row or control column that does not begin with any of the reserved action tags.

NOTES:  

  • The primary ActionCodes tag must be located in the first 500 rows of the sheet.

  • The ActionCodes tag can be placed within a formula, as long as the starting bracket and identifying tag are present as a whole within the formula. For more information, see Using formulas with Axiom feature tags.

Using multiple ActionCodes tags

You can have multiple ActionCodes tags in the same sheet, and they will all be processed when one of the triggering events occurs.

If you have more than one ActionCodes tag in a sheet, it is possible to create situations where action pairs from one ActionCodes control intersect on the same action cell as pairs from another ActionCodes control. Make sure to check for this when testing the action code implementation. If necessary, you can use named actions to work around this (see Using named action tag pairs).

Using a named ActionCodes tag

You can name an ActionCodes tag so that it can be explicitly run using manual processing commands. The syntax for a named tag is as follows:

[ActionCodes:Name]

IMPORTANT: Named ActionCodes tags are ignored during normal action code processing (i.e. after Axiom query refresh and during calc method insertion or change). For more information, see How action code processing executes.

The typical use case for named tags and manual processing is in Axiom forms. Using a button command, users can trigger processing of a particular named tag at a particular point in the form processing.