AX1330

Favorites command

Use the Favorites command to display a user's saved favorites.

Can be used in

  • Task panes, including web navigation task panes
  • Ribbon tabs

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

Shortcut parameters

This command does not have any shortcut parameters.

Visibility

Items using this command are only visible if the user has favorites to display. You can use the Show restricted item 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).

Using the Favorites command in the Desktop Client

This command displays the contents of the user's Favorites. The files display as a drop-down menu in ribbon tabs, and as an expandable/collapsible item in task panes.

The user can open a file from this location, but the user cannot perform any favorite management actions such as adding or removing items, or creating subfolders. 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).

Using the Favorites command in the Web Client

The Favorites command can be used in web navigation task panes, to provide lists of links to display in the Web Client when viewing forms. The favorites display as an expandable/collapsible list of items in the navigation panel.

When used in this context, the list of favorites is limited to only displaying form-enabled files that can be opened in the Web Client. If the user does not have any form-enabled favorites, then the Favorites item will not display in the navigation panel.

NOTE: Currently, there is no way for users to save favorites within the Web Client. Therefore this command will only be useful to users who also have access to the Desktop Client and can save form-enabled favorites in that environment. Within the Web Client, the form-enabled favorites will always be opened as forms, regardless of how they may be configured to open in the Desktop Client.