AX1180
Ribbon tab properties
The following properties are available for items in a ribbon tab. If you are editing one of the built-in ribbon tabs (Axiom and Axiom Designer), see the following for more information on those tabs: Built-in task panes and ribbon tabs.
The available settings for each item in a ribbon tab depends on whether it is a top-level group item, or a child item in a group.
Top-level group items
Each top-level item in the ribbon structure is a group item. Group items are identified in the ribbon structure with a gray bar.
Generally speaking, group items define the label for each "group" or section of items in the ribbon tab. Most group items only have a single property of Group Name. However in a few cases groups can have assigned Shortcut Targets and can be used to include entire groups of content in the ribbon.
| Item | Description |
|---|---|
|
Group Name |
The label to display for the group in the ribbon tab. If the group has an assigned Shortcut Target, then you can leave this box blank and the group name will be determined by the shortcut target. Otherwise, if no group name is defined then the group will have no label in the ribbon tab. The only indicator of a separate group will be the divider lines between groups. |
|
Use large image |
This option only applies if the group item is an Axiom Managed Group. If this option is selected, then all items that belong to the managed group will display using the large versions of their associated icons, instead of the small versions. By default, all items display using the small versions of their associated icons. NOTE: Using large icons can quickly fill up the ribbon tab. It is recommended to use small icons for managed groups unless you know there will be adequate space on the ribbon tab for the large icons. |
| Shortcut Target |
The target command in the Command Library to use for the group item. This is only permitted in two circumstances:
NOTE: It is not possible to add a "blank" group item to the ribbon structure and then link it to the desired shortcut target, because the Shortcut Target field does not display by default for group items. Instead, you must drag and drop an eligible command from the Axiom Explorer pane to the Ribbon Structure pane. (Or, you can add a child item to the ribbon structure, link it to the desired command, and then move that child item up to the group level. This is only permitted if the command is eligible to be used at the group level.) |
| Shortcut Parameters |
This section only applies if the group item uses the Excel Command Button. You can use the shortcut parameters to specify which Excel group should display on the ribbon tab. |
Child items
Each child item within a group defines a feature or file to display in the ribbon tab.
| Item | Description |
|---|---|
|
Display Text |
The text to display for the item in the ribbon tab. If the item has a defined shortcut target to an Axiom file or feature, then you can leave this box blank, and the display text will be the name of the file or feature. |
|
Tool Tip |
The text to display as a tool tip when a user hovers their cursor over the item. This text can be helpful to explain the purpose of the item within the context of the ribbon tab. If no tool tip text is defined, then the tooltip displays the full path of the shortcut target (if defined). |
|
Custom Image |
The image to display for the item on the ribbon tab. Click the Browse button [...] to select an image that is stored in the Reports Library. If the image is not already saved in the Reports Library, you can right-click a folder and select Import to import the image (if you have the appropriate rights to do so). The image must be at least 32x32 pixels, and the file format must be JPG or PNG. Larger images will be resized to fit. The image should be square because the aspect ratio will be retained when resizing. NOTE: End users must have permission to the image file in order to see it rendered in the task pane. It is recommended to create a dedicated Images folder in the Reports Library and store all images in this location. You can grant access to this folder using the Everyone role, or you can create subfolders and grant access to users and roles as needed. If no custom image is defined, then the default Axiom image for the shortcut target will be used. This option does not apply if the shortcut target for the item is a command that displays with a check box (such as Freeze Panes). |
Display settings
| Item | Description |
|---|---|
| Display child items inline |
Select this option if you want all of this item's child items to display inline, omitting this item. For example, this might be used when linking to a folder, to hide the "folder" node and instead display the resulting files inline. NOTE: If this option is selected for an item that does not have any child items, then the item will be hidden in the ribbon tab. |
|
Show restricted item |
Select this option if you want this item to always display in the ribbon tab, regardless of the user's security permissions and regardless of the current context. This option is selected by default. If the item cannot be used by the user, then it will display as grayed out. If this option is disabled, then the item will not display on the ribbon tab if it cannot be used. It is common to disable this option when placing file groups on a ribbon tab, so that users only see the file groups that they have security permission to access. |
|
Use large image |
Select this option if you want the item to display using the large version of its associated icon, instead of the small version. By default, all items display using the small version of the associated icon. This option does not apply if the shortcut target for the item is a command that displays with a check box (such as Freeze Panes), or if the item is rendered in a drop-down list on the ribbon. Only items that display directly on the ribbon as buttons are eligible to use large icons. |
Shortcut settings
| Item | Description |
|---|---|
| Shortcut Target |
The target file or feature for the item. Click the Browse button [...] to select the desired file or feature. You can select any item that you can navigate to within Axiom Explorer, including using commands in the Command Library. For more information, see Linking to Axiom files and features in a task pane or ribbon tab. Alternatively, you can drag and drop items from the Axiom Explorer pane in the editor directly to the ribbon tab structure, to both create a new item and link it to that file or feature. Once a shortcut target is defined, Axiom Software places the necessary syntax to open the target within the Shortcut Target box. It is best not to manually edit this text, as you may inadvertently render the syntax invalid. If you want to select a different target, use the Browse button to select the target rather than editing the target syntax. If you no longer want the item to link to a shortcut target, click the Delete button NOTE: All child items in the ribbon tab structure should be assigned a shortcut target, with one exception. If you are configuring an item as a split button or a drop-down menu, and you want to place a separator in the drop-down menu, then you would leave the shortcut target for the item blank and just define display text. Otherwise, child items without an assigned shortcut target will not display in the ribbon. |
| Shortcut Parameters |
Most shortcut targets have one or more associated shortcut parameters that impact the behavior of the linked file or feature when it is opened from the ribbon tab. The available parameters depend on the shortcut target—for example, report files have different parameters than tables. For more information, see the following:
|
to remove the shortcut.