AX1149

Add Rows command

Use the Add Rows command to add or change rows in a plan file using calc methods. All options that are available from the Add Row(s) button on the default Axiom ribbon tab can be executed using this command.

Can be used in

Axiom forms (for inserting rows only)
Task panes
Ribbon tabs

This command is included in the default AxiomMain.AXL ribbon tab, as part of the File Options group.

When the Add Rows command is selected from the Command Library as the shortcut target, it displays as command://AddRows or command://AddRowsCommandAdapter (legacy syntax).

Shortcut parameters

This command uses the following shortcut parameters:

Item	Description
Mode	Specifies the Add Rows behavior for the command: Default: This option is primarily for backward-compatibility. It has the same behavior as Insert mode, but the display name and icon remain at the base "Add Row(s)". Insert: Allows insertion of a calc method. The display name and icon are the same as the Insert Calc Method(s) command on the Add Row(s) menu on the default Axiom ribbon tab. Update: Allows changing the calc method for the current selection in the sheet. The behavior, display name, and icon are the same as the Change Calc Method command on the Add Row(s) menu on the default Axiom ribbon tab. Menu: Displays the full Add Row(s) menu as seen on the default Axiom ribbon tab. NOTE: If you are using the command in an Axiom form, then the mode is automatically set to Default and the Mode parameter does not display. The only parameter options are the additional parameters shown in the following table.
When using Default or Insert mode, you can complete the following additional parameters if you want the command to insert a calc method at a specific custom insertion point (this is required if you are using the command in an Axiom form). Otherwise, you can leave the additional parameters blank, and instead the command will behave like the Insert Calc Method(s) command on the Add Row(s) menu.
Target Sheet	The sheet in which to search for the specified calc method control tags. If omitted, the current sheet is assumed.
Column Label	The header label defined in the InsertCMColumn tag or the DynamicCMColumn tag, to identify the insertion column. If the target column is an InsertCMColumn, then the Row Label must also be defined to specify the insertion point. If the target column is a DynamicCMColumn, then the dynamic calc method insertion process is launched.
Row Label	Required if the target column is an InsertCMColumn; ignored if it is a DynamicCMColumn. The insertion point label defined in the InsertCM tag, to identify the insertion point.
Processing step	Specifies when the command will be executed during the Axiom form update process. This option only applies when using the command in an Axiom form. This option is set to Form - After Updating Values and cannot be changed. For more information, see Timing of command execution and Axiom form update process.

For example, if the custom insertion point on the Add Row(s) menu looks like this:

Then to replicate this behavior using the Add Rows command, the shortcut parameters would look like this:

Visibility

In task panes and ribbon tabs, items that use this command are only visible if both of the following conditions are met:

The currently active document supports use of calc method libraries.
The currently active document belongs to a file group where the user has the appropriate security permissions to insert calc methods.

You can use the Show restricted item option for the task pane or the ribbon tab to force the item 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 user does not have the appropriate permissions, or if the command is used in a context that does not support use of calc method libraries, then an error message displays when the user attempts to add a new row.

Remarks

Special requirements and design considerations apply when using this command in an Axiom form. For more information, see Inserting calc methods in an Axiom form.