AX2692

Linking to Axiom files and features in a task pane or ribbon tab

Items in a custom task pane or a ribbon tab can be linked to an Axiom file or feature. To link an item to a file or feature, you use the Shortcut Target property for the item. Depending on the shortcut target, there may also be Shortcut Parameters to further configure the behavior of the shortcut.

To define a shortcut for an item in a task pane or a ribbon tab:

  1. In the Edit Task Pane dialog or the Edit Ribbon Tab dialog, select the item that you want to link to a file or feature.

  2. Click the Browse button [...] to the right of the Shortcut Target box. Then, in the Axiom Explorer dialog, navigate to the item that you want to link to.

    You can link to any folder, file, or other item that is displayed in Axiom Explorer. Additionally, the Command Library is available when defining task panes and ribbon tabs, so that you can link to Axiom features. For more information, see the following reference material:

    • Shortcuts

      This section details shortcut behavior and available parameters when linking to various file types.

    • Command Library

      This section details shortcut behavior and available parameters when using items in the Command Library.

    NOTE: You can also link items to files and features by using the Axiom Explorer pane within the editor. If you drag and drop an item from the Axiom Explorer pane to the task pane or ribbon tab definition, then a new item will automatically be created and that item will be linked to the appropriate shortcut target.

  3. Configure the available Shortcut Parameters for the item, if applicable.

    Some items have additional options that impact how the item behaves in the task pane or the ribbon tab. The available options are specific to the item type.

  4. Define the Display Text for the item as desired.

    By default, the item will display using the name of the shortcut target—for example, the file name if the target is a file. If you want to specify a different name, then enter different text into the Display Text box.

If you assign a shortcut target to an item and then later you want to remove the shortcut, click the Delete button to the right of the box. You can also click the Browse button again to select a different shortcut target.

Visibility of linked items

The visibility of a linked item in a task pane or a ribbon tab depends on the following:

  • Whether the user has rights to access the linked file or feature. In most cases, if a user does not have permission to an item, the item does not display in the task pane or ribbon tab. For example, if the item links to a report that the user does not have access to, the item does not display because the user cannot open the report.

  • Whether the linked feature applies to the currently active file. In most cases, if the item is a file-related feature but it does not apply to the currently active file type, then the item does not display in the ribbon tab. For example, if the item links to the Add Rows command, but the currently active file is a report, then the item does not display because calc method libraries cannot be used in report files.

  • Whether the linked item is valid. If the shortcut target of an item is invalid, then the item does not display in the task pane or ribbon tab because it cannot be used. A user with the appropriate permissions must go to the editor to see and fix the invalid item. For example, if the item links to a report but the report is later deleted, the item does not display because it is invalid.

  • Whether Show restricted item is enabled for the item. If enabled, then the item will always display, regardless of any of the previously-listed factors. If the item cannot be used for any reason, then it displays as grayed out. You might enable this option if you want the items in the task pane or ribbon tab to remain constant for all users and all contexts.

NOTE: The visibility rules above are general guidelines. Certain commands have different behavior. See the help topic for the specific command for more information on the visibility rules for that command.

The default state of Show restricted item depends on whether you are creating a task pane or a ribbon tab. In task panes, the option is disabled by default, meaning that items will be hidden if the user cannot use them. In ribbon tabs, the option is enabled by default, meaning that items will display as grayed out if the user cannot use them. For more information, see Task pane design considerations and Ribbon tab design considerations.