Actions
Within a component, buttons can be created that trigger actions. These buttons are always displayed at the top of the screen before the content of the component. Typical actions include deleting and saving of content. Actions are defined within the <Actions>
element.
The following actions can be defined:
- Action „New“:
<NewAction/>
- Action „Save“:
<SaveAction/>
- Action „Delete“:
<DeleteAction/>
- Action „Select“:
(<SelectAction/>)
- Action „File upload“:
<UploadAction/>
- Action „Download file“:
<DownloadAction/>
- Custom Action:
(<CustomAction/>)
- Action "Reload":
<ReloadAction>
- Action "Cancel":
<CancelAction>
(7.4.0-en) Action "Select":
<SelectAction>
TheSelectAction
action does not create a button.
All actions except custom actions and the SelectAction
have predefined display names and icons. These may be overwritten if necessary.
The following table explains the attributes that can be used for all actions.
Attribute | Description |
---|---|
background | Defines a color for the background of the button. This setting overwrites the default color of the color scheme! Possible values:
|
componentName | Name of the component to navigate to at the end of the action. Possible values: Any string This attribute cannot be defined for the action "Cancel" and will result in a validation error if the attribute is set anyway. |
displayName | Label of the button.
Possible values: Any string or translation key Note: This attribute cannot be defined for the |
enabled | Activates the action
Possible values: The |
fontFamily | Defines the font family. This attribute overwrites the default font family of the Web App for this control. Possible values: Font code from the font palette, e.g. |
fontSize | Defines the font size. This attribute overrides the default font size of the Web App for this control. Possible values:
|
fontStretch | Defines the width of the single characters. This attribute overrides the default width of the characters for this control. Possible values:
|
fontStyle | Defines the font inclination. This attribute overrides the default inclination of the characters for this control. Possible values:
|
fontWeight | Defines the font weight. This attribute overrides the default weight of the characters for this control. Possible values:
|
foreground | Defines a color for the foreground (texts, icons) of the button.
Possible values:
|
iconColor | Defines the color of the icon. Possible values:
|
iconPosition | Defines the position of the icon on the button. Possible values:
|
iconUrl | Path to an image file or specification of a Material Icon to be used as an icon.
Possible values:
With |
process | Path to the Possible values: String (URI) This attribute cannot be defined for the action "Cancel" and will result in a validation error if the attribute is set anyway. |
selectionNeeded | Defines if an entry in the list has to be selected to perform the action. Works only in list components. Possible values: |
tooltip | Defines the text that is displayed as tool-tip of the action when the action button is hovered with the cursor. Possible values: String If the value of the |
visible | Defines if the button for the action is visible.
Possible values: |
Each of the above actions can be extended with the <Parameters>
element. Within the <Parameters>
element, you can set further definitions using the <Parameter>
element.
The <Parameter>
element contains the following mandatory attributes:
Attribute | Description |
---|---|
key | Name of the parameter
Possible values: string or data binding expression |
value | Parameter value
Possible values: string or data binding expression |