AX1248

File Attachment command

Use the File Attachment command to add, view, or manage file attachments for a plan file (depending on the user's level of permissions to the plan file).

Can be used in

Axiom forms
Ribbon tabs
Task panes

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

When the File Attachment command is selected from the Command Library as the shortcut target, it displays as command://FileAttachment or command://FileAttachmentCommandAdapter (legacy syntax).

Shortcut parameters

When used in task panes and ribbon tabs, this command does not have any shortcut parameters. It only applies when the currently active file is a spreadsheet plan file that belongs to a file group where the File Attachments feature is enabled. It uses the same behavior as the File Attachments button on the default Axiom ribbon tab.

When used on a button in Axiom forms, the command has the following shortcut parameters. It can be used in a plan file to open attachments for that plan file, or in a report to open attachments for one or more plan files.

Item Description

Item	Description
File Group	The file group for the command. Click the folder icon to select a file group. You can select any file group or file group alias. If you are using the command in a file that belongs to a file group, then an additional option is available at the top of the file group list: Use Current File Group. This option means that the command will always point to the file group where the file is currently located, even if you clone the file group or copy the file to a different file group. This is the recommended option when using this command in a file that belongs to a file group.
Plan Code Value	The plan file for which to open the Web Client File Attachments dialog. You can specify the plan code value directly, or use a bracketed cell reference to read it from a cell in the file. For example: `[SharedVariables!D12]` If you are configuring the command on a Button tag for a Formatted Grid component, then you can use either a bracketed cell reference or just a column letter in brackets. If using a column letter, such as `[J]`, then the plan code value will be read from the specified column on the current row of the grid.
Processing Step	Specifies when the command will be executed during the Axiom form update process. This option is set to Form - Before Processing and cannot be changed. For more information, see Timing of command execution. NOTE: When a button uses this command, the form update cycle does not occur. The only action the button performs is to open the Web Client File Attachments dialog. Other commands cannot be combined with this command.

File Group

The file group for the command. Click the folder icon to select a file group. You can select any file group or file group alias.

If you are using the command in a file that belongs to a file group, then an additional option is available at the top of the file group list: Use Current File Group. This option means that the command will always point to the file group where the file is currently located, even if you clone the file group or copy the file to a different file group. This is the recommended option when using this command in a file that belongs to a file group.

Plan Code Value

The plan file for which to open the Web Client File Attachments dialog. You can specify the plan code value directly, or use a bracketed cell reference to read it from a cell in the file. For example: [SharedVariables!D12]

If you are configuring the command on a Button tag for a Formatted Grid component, then you can use either a bracketed cell reference or just a column letter in brackets. If using a column letter, such as [J], then the plan code value will be read from the specified column on the current row of the grid.

Processing Step

Specifies when the command will be executed during the Axiom form update process. This option is set to Form - Before Processing and cannot be changed. For more information, see Timing of command execution.

NOTE: When a button uses this command, the form update cycle does not occur. The only action the button performs is to open the Web Client File Attachments dialog. Other commands cannot be combined with this command.

Visibility

In task panes and ribbon tabs, items that use this command are only visible if the current file is a plan file that belongs to a file group where the File Attachments feature is enabled. 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 command points to a file group where attachments are not enabled, then an error message displays when the user clicks the button.

Remarks

When used in a task pane or ribbon tab, the command opens either the Browse Attachments dialog or the Manage Attachments dialog for the current plan file, depending on whether the user has read / write access to the plan file.
When used in an Axiom form, the command opens the Web Client File Attachments dialog for the specified plan file, even if the form is opened within the Desktop Client. The actions available in the dialog vary depending on whether the user has read / write access to the plan file. The Web Client File Attachments dialog displays and behaves in a similar manner as the File Attachments panel in the Web Client task bar. For more information on using the command in an Axiom form, see Using a button in a form to manage attachments.