AX2717
Save Document command
Use the Save Document command to perform a save action on the current document. You can use the shortcut parameters to specify which save action to perform.
Can be used in
- Ribbon tabs
- Task panes
This command is included in the default AxiomMain.AXL ribbon tab, as part of the File Options group.
When the Save Document command is selected from the Command Library as the shortcut target, it displays as command://SaveDocument or command://SaveDocumentCommandAdapter (legacy syntax).
Shortcut parameters
This command uses a single shortcut parameter named Save Mode. This parameter determines which save action will be performed by the item:
| Save Mode | Description |
|---|---|
|
Save |
Saves the file and performs a save-to-database (if the file is configured to do so). This option is selected by default. |
|
Save File Only |
Saves the file only. Save-to-database processes are not performed. |
|
Save Data Only |
Performs a save-to-database if the file is configured to do so. The file itself is not saved. |
|
Save As (Local File) |
Brings up the Save As dialog so that a copy of the file can be saved to the user's local machine or to a shared network folder. |
|
Save As (Repository) |
Brings up the Save As dialog so that a copy of the file can be saved to the Reports Library (or to My Documents, if the user has rights to this location). |
The default display text for the command will automatically adjust based on the Save Mode selection.
Visibility
Items using this command are visible if both of the following conditions are met:
-
The selected save mode is applicable to the current document. For example, if the command is set to Save Data Only but the current file is not configured to save to the database, then the item is not visible because it is inapplicable.
- The user has the appropriate permissions to perform the selected save mode. For example, if the command is set to Save Data Only, but the user does not have rights to perform a save-to-database for the current file, then the item is not visible because the user can't perform the action.
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 for use).
