AX2704

Add to Favorites command

Use the Add to Favorites command to allow users to add the currently active file to their Favorites list.

This command only works on files that are open within the spreadsheet file area. Users must use other methods to add items like imports or Scheduler jobs to their favorites, such as right-clicking the file in the Explorer task pane.

Can be used in

• Ribbon tabs
• Task panes

When the Add To Favorites command is selected from the Command Library as the shortcut target, it displays as command://AddToFavorites or command://AddToFavoritesCommandAdapter (legacy syntax).

Shortcut parameters

This command does not use any shortcut parameters.

Visibility

Items using this command are only visible if the current document is eligible to be added to the user's favorites. 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).

Remarks

This command only allows adding files as favorites, it does not provide access to the Favorites list. If you want users to be able to access and edit their Favorites list from a custom user interface, the recommended method is to use the Axiom Explorer Tree View command in a task pane. You can use the shortcut parameters for this command to only display the My Files area of Axiom Explorer, which includes Favorites, Recent, and My Documents (if applicable).

Alternatively, it is possible to link to the Favorites "folder" by using the Favorites command. However, doing this will only display the Favorites list and allow users to open these files; it does not provide any editing functionality such as deleting favorites from the list, reorganizing favorites, or creating subfolders.