- Description
- Actions and Menus
- How to use it
- 1. Create a new Action
- 2. Edit the functionality of your action
- 2.1 Action types
- 2.2 Action layout options
- 2.2 States
- 2.3 Events
- 2.4 Other options
Description
An action (also called menu function) is a no-code function that can be defined directly in the UI interface of Build.One. These actions are used for a wide variety of use cases. Among other things, to launch screens, to provide ribbons and toolbars or other buttons with functions or to execute specially written code.
Actions and Menus
The actions define the logic behaviour of a function but they do not define the visual design of how those actions can be triggered. For that purpose the 
Menu structure is used. Menu structure can have an action linked to them, and it is in the menu where the visual design of the trigger of the action can be customised. Menu structure allow to use the action in different visual elements, it can be used in 
Toolbar, Ribbon or other elements defined in the Menu structure article.
How to use it
1. Create a new Action
- Navigate to Design → Actions & Menus → Actions
- Click on the button “New”
- Provide the data of your new action
- Function Name is the user readable name of your action
- For the Function type use
Akioma.Swat.Studio.Menu.Action - Function Code is the unique identifier of your action
- Other data like Icons, Description or Security tokens GUID are optional
- Click on Confirm and another window will open to add functionality to your action.
2. Edit the functionality of your action
After creating an action or If you open an already created action, you will see the Action designer
- In the top panel you will find the basic data completed during the creation of an action
- In the bottom panel you will find the Action parameters where the logic or other settings of the Action can be customised.
2.1 Action types
Type | Explanation |
Launch | Action to launch a screen |
Publish | Action to save something in a datasource |
Run | Action to execute a custom function |
Invoke | Action to call a REST API |
2.2 Action layout options
Option | Explanation |
Is Default Action | When used in the menu of a toolbar in a dialog, it will be used for the “Confirm” button of a dialog |
Is Cancel Action | When used n the menu of a toolbar in a dialog, it will be used for the “Cancel” button of a dialog |
Is big | When used in a Ribbon, the button will be displayed in a big format |
2.2 States
State | Explanation |
Is Disabled | When used in a menu of a toolbar, the button of this action will be disabled |
Is Hidden | When used in a menu of a toolbar, the button of this action will be hidden |
Is Development | When used in a menu of a toolbar, the button of this action will be hidden for development |
Display only image | When used in a menu of a toolbar, the button of this action will only display the icon |
2.3 Events
Option | |
Event pre | Typescript function that will be triggered just before executing this action. |
Event post | Typescript function that will be triggered just after executing this action. |
Create Event | Typescript function that will be triggered when the screen that has a Menu structure with this action is opened. |
2.4 Other options
Option | Explanation |
Tooltip | Shows a tooltip in the menu structure containing this action |
Shortcut | Keyboard shortcut to execute this action (following a structure like CTRL-ALT-C) |
Visibility Rules | Visibility rules for this action |
Custom Style | Custom style for this action |
Back to 
Documentation
Back to Home Page