Ribbon

Commands: Ribbon and RibbonClose

A ribbon organizes tools in a series of Panels (2) which are grouped in different Tabs (1).
The number of tabs and their order depends on the current workspace and is defined in the Ribbon node of the workspace (see Editing a Workspace).



The RibbonDockedHeight system variable stores the preferred height of the Ribbon bar. Values between 0 and 500 are accepted. Set the value to 0 (zero) for automatic height calculation.

Ribbon Panels

A ribbon panel is composed of one or more rows. In a row you can add one or more command buttons or row panels, which in turn can hold one or more command buttons.

The Entity Snaps ribbon panel above is composed of:

• a launcher (1)

• a single row, holding three command buttons (2), a row panel (3) with three rows of four command buttons each, two command buttons (4) and a row panel (5) with three rows of one command each.

Ribbon Buttons

The following button types are available:

• Command button (2): launches a command

• Split button (1): groups a series of command buttons, much like a flyout toolbar.

• Toggle button (3): toggles a setting; shows the current status of setting

Creating a ribbon tab

1. Open the Customize dialog.

2. Click the Ribbon tab on the Customize dialog.

3. Right click the Ribbon tabs group and choose Append ribbon tab in the context menu.

4. Fill out the fields in the Add Ribbon Tab dialog box:

   

   Label: Caption on the ribbon tab.
   Title: Used in the Select Ribbon Tab dialog when selecting ribbon tabs for a workspace (see Editing a Workspace).
   ID: A unique name to identify the ribbon tab.

5. Click the OK button.

Editing a ribbon tab

1. Open the Customize dialog.

2. Click the Ribbon tab on the Customize dialog.

3. Expand the Ribbon tabs group.

To add a panel to a ribbon tab

1. Do one of the following:

   • Right click the ribbon tab and choose Append panel in the context menu, to add a panel at the end.

   • Right click an existing panel and choose Insert panel in the context menu, to ad a panel above the existing panel.

2. Select the panel in the Select Ribbon Panel dialog, then click the OK button.
   
   

3. Optional: Drag the panel to a different position.

To remove a panel from a ribbon tab

1. Select the panel.

2. Do one of the following:

3. Press the Delete key.

4. Right click and choose Remove in the context menu.

Creating a ribbon panel

1. Open the Customize dialog.

2. Click the Ribbon tab on the Customize dialog.

3. Right click the Ribbon Panels group and choose Append ribbon panel in the context menu.

4. Fill out the fields in the Add Ribbon Panel dialog box:

   

   Label: Caption of the panel in the ribbon.
   Title: Used in the Select Ribbon Panel dialog when selecting the panels for a ribbon tab
   ID: A unique name to identify the ribbon panel.

5. Click the OK button.

Editing a ribbon panel

1. Open the Customize dialog.

2. Click the Ribbon tab on the Customize dialog.

3. Expand the Ribbon Panels group.

4. Expand the ribbon panel.

To add a row to a ribbon panel

Do one of the following:

• Right click the ribbon panel and choose Append Row in the context menu.
  The row is added at the bottom of the ribbon panel tree.

• Right click an existing row and choose Insert Ribbon Row in the context menu.
  The row is added above the existing row.

• Optional: Drag the row to a different location in the ribbon panel tree.

To add a launcher to a ribbon panel

1. Right click the ribbon panel and choose Add launcher in the context menu.

2. Either select an available tool or Create a New Tool, then click the OK button.

   

Editing a panel row

1. Open the Customize dialog.

2. Click the Ribbon tab on the Customize dialog.

3. Expand the Ribbon panels group.

4. Expand the ribbon panel.

5. Expand the ribbon rows and ribbon row panels.

To add a row panel to a row

Do one of the following:

• Right click the row and choose Append Row Panel in the context menu.
  The row panel is added at the bottom of the row tree.

• Right click an existing row panel and choose Insert Row Panel in the context menu.
  The row panel is inserted above the existing row panel.

To add a command button to a row

1. Drag and drop a tool from the Available Tools list onto the row.
   Drop the tool on the row to add a command button at the bottom of the row tree.
   Drop the tool on an existing command button to add a command button above an existing command button.

2. Set the Button Style in the Command Button grid.

   

   The options are:

   Icon	Style
   	Small
   	Small with text
   	Large
   	Large with text

3. Optional: Drag the command button to a different position in the same row or onto a different row.

To add a split button to a row

1. Select the row, then right click and choose Append split button in the context menu.
   The split button is added at the bottom of the row tree.

2. Drag a series of related tools from the Available Tools list onto the split button.

3. Set the Button Style in the Split Button grid.

   

   The options are:

Icon	Style
	Small
	Small with text
	Large
	Large with text

1. Type a label text in the Label field.

2. Optional: Set the Behavior to Split with recent (static text) : always display the split button label, instead of the label of the most recently used tool.

3. Optional: Drag the split button to a different position in the same row or onto a different row.

4. Drag and drop tools from the Available Tools list onto the split button.

To add a toggle button to a row

1. Select the row, then right click and choose Append Toggle Button in the context menu.

2. Either select an available tool or Create a New Tool, then click the OK button.

   

3. The toggle button is added at the bottom of the row tree.

4. Optional: Drag the toggle button to a different position in the same row or onto a different row.

To add a control to a row

1. Drag a control from the controls list onto the row.

2. Drop the control on the row to add it at the bottom of the row tree.

3. Drop the control on a existing command button to add it above the command button.