AX1156

Excel Command Button command

Use the Excel Command Button command to include an Excel feature in an Axiom ribbon tab.

Can be used in

Ribbon tabs

Excel commands are only supported for use in the Axiom Excel Client. These commands will not work in the Windows Client.

When the Excel Command Button command is selected from the Command Library as the shortcut target, it displays as command://ExcelControl or command://ExcelControlCommandAdapter (legacy syntax).

Shortcut parameters

This command uses the following shortcut parameters:

Item Description

Item	Description
Excel Control ID	Enter the ID of an Excel control. This ID is in text format, such as `Cut` for the Cut control, or `DataValidation` for the Data Validation control. The easiest way to find the ID of an Excel control is to go into Excel Options, and then go to Customize Ribbon or Quick Access Toolbar. Find the command that you want to add to the ribbon tab, and then hover your cursor over it until the tooltip shows. The control ID is listed at the end of the tooltip, in parentheses. Alternatively, you can obtain official lists of these control IDs from Microsoft. The following links are current as of this release; Microsoft may change the location and availability of these lists at any time. Excel 2013 (external link) Excel 2016 (external link)
Excel Control Type	Select the control type for the ID specified in Excel Control ID. This can be one of the following: Button SplitButton ToggleButton Menu Group Each Excel control ID has an assigned control type. You must specify the correct type for the control ID. In many cases the appropriate control type is obvious based on how the control displays on the Excel ribbon tabs. If it is not obvious, you can look up the appropriate control type from the official list of control IDs provided by Microsoft (see the discussion for Excel Control ID above). The Group option is only valid if the ribbon tab item is a top-level group item (and if the specified control ID is a group type). When used, it will display all of the Excel control IDs that belong to the specified group as a group on the custom ribbon tab. This is an easy way to replicate entire sections of an Excel ribbon tab on a custom ribbon tab. When used, the ribbon tab item cannot have any child items.

Excel Control ID

Enter the ID of an Excel control. This ID is in text format, such as Cut for the Cut control, or DataValidation for the Data Validation control.

The easiest way to find the ID of an Excel control is to go into Excel Options, and then go to Customize Ribbon or Quick Access Toolbar. Find the command that you want to add to the ribbon tab, and then hover your cursor over it until the tooltip shows. The control ID is listed at the end of the tooltip, in parentheses.

Alternatively, you can obtain official lists of these control IDs from Microsoft. The following links are current as of this release; Microsoft may change the location and availability of these lists at any time.

Excel 2013 (external link)
Excel 2016 (external link)

Excel Control Type

Select the control type for the ID specified in Excel Control ID. This can be one of the following:

Button
SplitButton
ToggleButton
Menu
Group

Each Excel control ID has an assigned control type. You must specify the correct type for the control ID. In many cases the appropriate control type is obvious based on how the control displays on the Excel ribbon tabs. If it is not obvious, you can look up the appropriate control type from the official list of control IDs provided by Microsoft (see the discussion for Excel Control ID above).

The Group option is only valid if the ribbon tab item is a top-level group item (and if the specified control ID is a group type). When used, it will display all of the Excel control IDs that belong to the specified group as a group on the custom ribbon tab. This is an easy way to replicate entire sections of an Excel ribbon tab on a custom ribbon tab. When used, the ribbon tab item cannot have any child items.

Visibility

The visibility of items using this command is determined as follows:

In the Excel Client, items using the command are always visible, but grayed out if the control is inapplicable to the current context (this availability is determined by Excel).
In the Windows Client, items using this command are always hidden because they cannot be used.

Remarks

Items using this command do not display in the ribbon preview. You must assign the ribbon tab as a startup file and then restart the Excel Client in order to view and test the command.
When using this command, you cannot define alternate display text for the item. The display text for the Excel command is determined by Excel and cannot be changed.