<Ribbon>

Attributes

Attribute

Description

Show

Determines whether there is a ribbon entry for the tool.

§   Show = “0” – Button does not display on ribbon.

§   Show = “1” (Default)– Button displays on ribbon.

splitButton

Determines whether the button is split into two halves where clicking the bottom half of the button opens a drop-down menu with sub-options, while clicking the upper half activates the “main” tool option, which will also be listed first in the drop-down menu:

§   splitButton = “0” - Button only opens a drop-down menu.

§   splitButton = “1” (Default)  Creates a button with two halves with functionality described above.

Toggle

Determines whether the ribbon command is a toggle button:

§   Toggle = “1” – The button functions as a toggle for opening and closing the tool.

§   Toggle = “0” (Default) – Clicking the ribbon button always launches the tool. When the tool is already open, clicking the button has no effect. 

Child Elements

Element

Description

Element’s Attributes

<Category>

Defines the new ribbon tab in which the new ribbon command should be placed. If no Category tag is specified, the new ribbon command is placed in the Tools tab.

id – Uniquely identifies the ribbon tab.

caption – Name of the new ribbon tab.-

<Panel>

Defines the ribbon group in which the new ribbon command should be placed. If this group does not yet exist, it is created. If no Panel tag is specified, the new ribbon command is placed in a default Tools group.

id - Uniquely identifies the ribbon group.

caption –Name of the ribbon group as it should be displayed on the ribbon.

<Submenu>

Defines a drop-down menu for the ribbon command.

See "<Submenu>” below.

<ToolTip>

Defines a tooltip that is displayed when placing the mouse cursor over the ribbon command.

title – Title of the tooltip.

description – Text of the tooltip.