Actions
You can create button that trigger actions within components. These buttons are always displayed at the top of the component's contents. Typical actions include deleting and saving content. Actions are defined within the <Actions>
element.
The following actions can be defined:
- "New" action :
<NewAction>
- "Save" action :
<SaveAction>
- "Delete" action :
<DeleteAction>
- "Upload file" action :
<UploadAction>
- "Download file" action :
<DownloadAction>
- "Custom" action :
<CustomAction>
- "Reload" action :
<ReloadAction>
- "Cancel" action :
<CancelAction>
"Select" Action :
<SelectAction>
TheSelectAction
action does not generate a button.
All actions except the CustomAction
and SelectAction
have predefined labels and icons. These can be overwritten if necessary.
The following table describes the attributes that can be used for all actions.
Attribute | Description |
---|---|
background | Defines a color for the background of the control. This setting overrides 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 "Cancel" action and will result in a validation error if the attribute is set anyway. |
displayName | Annotation of the control.
Possible values: Any string or language key This attribute cannot be defined for the |
enabled | Enables the action
Possible values: The |
fontFamily | Specifies the font family. This attribute overwrites the default Web App font for this layout. Possible values: Fontcode from the font palette, e.g. |
fontSize | Sets the font size. This attribute overrides the default Web App font size for this layout. Possible values:
|
fontStretch | Specifies the width of each character. This attribute overrides the default character width for this layout. Possible values:
|
fontStyle | Sets the tilt of the font. This attribute overrides the default font tilt for this layout. Possible values:
|
fontWeight | Sets the font weight. This attribute overrides the default font weight for this layout. Possible values:
|
foreground | Defines a color for the foreground (text, etc.) of the layout.
Possible values: |
iconColor | Defines the color of the icon. Possible values:
|
iconPosition | Specifies the position of the icon on the button. Possible values:
|
iconUrl | Path to a graphic file or specification of a material icon that is used as an icon of the component.
Possible values:
With |
process | Path to the Possible values: String (URI) This attribute cannot be defined for the "Cancel" action and will result in a validation error if the attribute is set anyway. |
selectionNeeded | Specifies whether an entry from a list must be selected for the action. Works only in List components. Possible values: |
tooltip | Specifies the text that is displayed as a tooltip of the action as soon as the cursor hovers above the action button. Possible values: String If the value of the |
visible | Specifies whether 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 use the <Parameter>
element to make additional definitions.
The <Parameter>
element contains the following mandatory attributes:
Attribute | Description |
---|---|
key | Name of the parameter
Possible values: String or expression for data binding |
value | Parameter value
Possible values: String or expression for data binding |