AX1243

Axiom Managed Group commands

Using the Axiom Managed Group commands, you can place system-managed groups of Axiom features on a custom ribbon tab or task pane. The following commands are available:

  • Admin Group
  • Advanced Group
  • Developer Group
  • Display Group
  • File Options Group
  • File Output Group
  • Help Group

When these commands are used in a ribbon tab or a task pane, they will automatically include all contents of the corresponding ribbon group (as defined by the default Axiom ribbon tabs). For example, if you use the Admin Group command, it will automatically include the contents of the Administration group on the Axiom ribbon: Tables menu, Imports menu, and Manage menu.

Additionally, these commands are system-managed and will automatically stay in sync with the contents of the default Axiom ribbon. For example, if Axiom Software adds a new menu item to the default Manage menu, and you are using the Admin Group in a ribbon tab, that group will automatically be updated for the new menu item. It is recommended to use group commands for your custom ribbon tabs whenever possible, to streamline ribbon maintenance and ensure that you have easy access to new features.

Can be used in

  • Ribbon tabs
  • Task panes

The default AxiomMain.AXL ribbon tab is designed using these groups. Currently, the default AxiomDesigner.AXL ribbon tab only uses one group, the Developer Group.

NOTE: Certain features within some groups are not supported for use in task panes and will not display when the group is used in a task pane.

When a group command is selected from the Command Library as the shortcut target, it displays as:

  • command://AdminGroup or command://AdminGroupCommandAdapter (legacy syntax)
  • command://AdvancedGroup or command://AdvancedGroupCommandAdapter (legacy syntax)
  • command://DeveloperGroup or command://DeveloperGroupCommandAdapter (legacy syntax)
  • command://DisplayGroup or command://DisplayGroupCommandAdapter (legacy syntax)
  • command://FileOptionsGroup or command://FileOptionsGroupCommandAdapter (legacy syntax)
  • command://FileOutputGroup or command://FileOutputGroupCommandAdapter (legacy syntax)
  • command://HelpGroup or command://HelpGroupCommandAdapter (legacy syntax)

Shortcut parameters

The group commands do not have any shortcut parameters. The behavior of the groups cannot be changed; they will always include the full contents of the corresponding group. The only way to modify the group contents is to convert the group into its individual commands.

Visibility

The visibility of the group commands depends on the visibility behavior of the individual items in the group (the dynamically determined group contents). This visibility is system-managed and depends on factors such as security permissions and the current file context. The Show restricted item option has no effect on the group commands.

Converting group commands to individual commands

If you want to customize the contents of a group—for example, to hide certain features or to add other features—you can choose to convert the group into its individual items. Once you do this, the commands in the group are no longer linked to the default ribbon tab and will not be updated for future changes to the group. This means that if Axiom Software adds a new feature to that group in a future version, or changes the configuration of that group, your custom ribbon tab will not update to match those changes. You will need to make the changes manually if you want them reflected in your custom ribbon tab.

To convert a group, right-click the item in the ribbon tab or task pane structure, and then select Convert group to individual items. The following occurs:

  • The group command is deleted from the ribbon tab or task pane structure.

  • A new top-level group item is created, and is assigned a group name that corresponds with the converted group. For example, if you convert the File Options group, the group name is "File Options".

  • Child items are created for each individual feature that is currently a part of that group. These items are configured as appropriate to replicate their default behavior on the ribbon.

After converting the group, you can modify the group item and its child items as desired. For more information and an example use case, see Customizing the Axiom ribbon tab.