Skip to main content
Skip table of contents

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:

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.

AttributeDescription
background

Defines a color for the background of the control.

This setting overrides the default color of the color scheme!

Possible values:

  • Hexadecimal color value, e.g. ff5a00

    Do not use a hash (#) before the color value!

    Do not use an abbreviated notation of the color value!

  • Color code from the color palette of the Web App (cf. Theming), e.g. A200
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.

  • Translatable

Possible values: Any string or language key

This attribute cannot be defined for the SelectAction.

enabled

Enables the action

  • Data binding (Boolean) is possible

Possible values: true/false or expression for data binding

The enabled attribute replaces the deprecated disabled attribute. Enabled="true" corresponds to the obsolete disabled="false" attribute.

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. Font04

fontSize

Sets the font size. This attribute overrides the default Web App font size for this layout.

Possible values:

  • Font size in pixels, e.g. 20px
  • Font size in points, e.g. 18pt
  • Font size compared to the font size of the parent element, e.g. .8em or 120%
  • Keywords, e.g. small or larger
fontStretch

Specifies the width of each character. This attribute overrides the default character width for this layout.

Possible values:

  • Condensed
  • Expanded
  • ExtraCondensed
  • ExtraExpanded
  • Medium
  • Normal (default)
  • SemiCondensed
  • SemiExpanded
  • UltraCondensed
  • UltraExpanded
fontStyle

Sets the tilt of the font. This attribute overrides the default font tilt for this layout.

Possible values:

  • italic: Italic font
  • normal: Normal font (default)
  • oblique: Slanted font style (calculated)
fontWeight

Sets the font weight. This attribute overrides the default font weight for this layout.

Possible values:

  • Black
  • Bold
  • DemiBold
  • ExtraBlack
  • ExtraBold
  • ExtraLight
  • Heavy
  • Light
  • Medium
  • Normal (default)
  • Regular
  • SemiBold
  • Thin
  • UltraBlack
  • UltraBold
  • UltraLight
foreground

Defines a color for the foreground (text, etc.) of the layout.

  • This setting overrides the default color of the color scheme!
  • If a custom icon is used for the action with the iconUrl attribute, this icon is not displayed in the custom color. The graphic file, which is used as an icon, must be stored directly in the desired color.

Possible values:

  • Hexadecimal color value, e.g. ff5a00

    Do not use a hash before the color value!
    Do not use a shortened notation of the color value!
  • Color code from the color palette of the Web App (cf.Theming), e.g. A200
iconColor

Defines the color of the icon.

Possible values:

  • Hexadecimal color value, e.g. ff5a00

    Do not use a hash before the color value, and do not use a shortened notation for the color value!
  • Color code from the color palette of the Web App (cf. Theming), e.g. A200
iconPosition

Specifies the position of the icon on the button.

Possible values:

  • left: The icon is displayed on the left side of the button (default).
  • right: The icon is displayed on the right side of the button.
iconUrl

Path to a graphic file or specification of a material icon that is used as an icon of the component.

  • The graphic file must be located in the Resources folder just below the Web App project. Path information relative to the Resources folder.
  • The material icon must be specified with the prefix icon, e.g. icon:<MaterialIconName>.

Possible values:

  • String (URI), for example, clock.png
  • Icon:<MaterialIconName> , for example, icon:extension

With CTRL+SPACE, you display an overview of the available icons. The selection may differ from the actual available material icons.

process

Path to the .wrf file. The Technical Process must be in the Services/Processes folder. Path information relative to the Resources folder.

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: true / false

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 tooltip attribute is empty, no tooltip is displayed.

visible

Specifies whether the button for the action is visible.

  • Data binding (Boolean) is possible

Possible values: true / false or string for data binding


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:

AttributeDescription
key

Name of the parameter

  • Data binding (Boolean) is possible

Possible values: String or expression for data binding

value

Parameter value

  • Data binding (Boolean) is possible

Possible values: String or expression for data binding

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.