• Description
• How to use it
• 1. Create a menu function
• 2. Create a menu structure
• 3. Add the ribbon to your screen
• Use Cases
• Attributes

Description

The Ribbons are created in Build.One using the SwatRibbon object. A SwatRibbon is a graphical control element in the form of a toolbar that can be added to a Screens.

How to use it

1. Create a menu function

To create a ribbon, you need to create a corresponding menu function. How to do this is explained on the following page. Actions.

Below is an example of a menu function for a save operation.

2. Create a menu structure

To create a ribbon, you need to create a corresponding menu structure. How to do this is explained on the following page. Menu structure

Below is an example of a menu structure for a new ribbon

1. Start of the menu structure for an application.
2. Group to organize an application.
3. Group for all ribbons to be used in this application.
4. Ribbon object. This object includes all relevant blocks for the ribbon and their associated buttons.
5. Ribbon block that can contain different buttons.
6. Actual button in the ribbon block within the entire ribbon. Here, the menu function for the button is defined, as shown in the above example.

3. Add the ribbon to your screen

1. To add the ribbon to the screen, search for "SimpleSwatRibbon" in the object catalog. Then, drag and drop it onto a specific panel or use it for the entire screen.
2. Next, connect the ribbon object in the Flow Designer to the respective object using the "TableIO" link type.
3. In the final step, populate the "ToolBarKey" attribute with the Menu Structure Code from the ribbon object in the Menu Structure. Refer to point 4 in the above image.

When using a ribbon, you need to use a "#" in the SimpleSwatRibbon object. It would look like this: Attributes: Toolbarkey → #Use me as Toolbarkey

To Find the Toolbarkey you can find it in the Menu details

Use Cases

✍️  If there are Use Cases that can be linked to this concept, you can use the next Notion Database view to display them

Attributes

Back to Documentation

Back to Home Page