Ribbon button (Portal)
By default, portals appear without a ribbon menu, since in contrast to Input forms they are not linked to a business object type, so there are no standard ribbon functions to display in a menu.
However, featuring a line-up of buttons in a ribbon menu to provide access to certain functions may be a useful approach in the context of a portal. For this purpose, Ribbon buttons can be added to the design of a portal in Form designer.
A ribbon button added to the design of a portal looks like a regular Button and provides the same basic settings (Button caption, Button icon, Active, Visible, etc.). Unlike other elements it does not appear at the configured position in the form section of an operative portal view. Instead, a ribbon menu appears above the form, as long as at least one ribbon button is configured and flagged as 'visible'. Inversely, the ribbon menu disappears if there is no 'visible' ribbon button to display.
Configuration
Features of the button
The following settings are relevant for operative use of ribbon buttons in a ribbon:
Button caption defines the caption of the ribbon button (optional)
Button icon defines the icon to display in the ribbon button (optional)
Active defines, whether a button appears as active or inactive in the ribbon
Visible defines, whether a button is visible in the ribbon or not
All other settings in the Common section (Data field, Label, Tooltip, Show label, Read only,Width, Height) are only considered in design view, if at all.
►NOTE◄ The status for Active and Visible can be synchronized for a group of ribbon buttons by placing them in a container element (e.g. Column layout or Row layout). if the individual elements are set to Active/Visible the group can be defined as inactive/invisible on the container level.
Positioning in the ribbon menu
Buttons can be positioned in the ribbon menu by references to the general structure with the main category level (defining tabs) and the subcategory level (defining groups of buttons per tab). The property editor features corresponding settings in a dedicated Ribbon section:
result (incl. button configuration, see above): 
For the main category and subcategory, the following three settings are available:
|
Main category settings |
Subcategory settings |
Effects |
|
Main category |
Subcategory |
Grouping of buttons by tabs/sections |
|
Main category priority |
Subcategory priority |
Sorting of tabs/sections (by descending priority) |
|
Man category label |
Subcategory label |
Labels for tabs/sections |
The option Forbid auto fold ribbon defines whether the ribbon bar may be folded automatically (usually due to missing space).
Hint: As soon as one of the configured ribbon buttons has this option enabled, the ribbon bar will not be folded automatically anymore.
Behaviour when the button is pressed
What happens when a user presses an active button in a ribbon men depends on the Behaviour types and actions configured for the ribbon button.
Typically, a Events (Form designer) 'Click' would trigger a behaviour, potentially executing specific Actions.
In this example, clicking the ribbon button activates the trigger Click, which executes Call profile, in order to issue a booking (in another system) by running a _data-Profile.
Depending on feedback from the profile (true = booking confirmed), the Actions on "true" are executed. The user is notified of the confirmation by Show alert and some features of the portal are adjusted according to the new situation ('booking confirmed') by Show element, Disable element and Enable element. In case the booking is not confirmed, the Actions on "false" foresee an alert only.