ActionBarItem¶
ActionBarItem is a control item that can be added to the action bar.
ActionBarItem Properties¶
| Property | Type | Required | Default |
|---|---|---|---|
| Caption | string |
Optional | |
| Icon | Image | Optional | |
| IconText | string |
Optional | |
| IsIconCircular | boolean |
Optional | false |
| OnPress | ActionOrRule | Optional | |
| Position | enum |
Required | |
| Style | string |
Optional | |
| SystemItem | SystemItem | Optional | |
| Visible | boolean |
Optional | true |
| _Name | string |
Optional |
Caption¶
This attribute acts as the placeholder text when Icon image fails to render due to some reason (missing/failed). In
Android, the Caption is required even if the SystemItem or Icon is defined, because in overflow menu, only
Caption will be displayed.
- type:
string
Icon¶
Icon provided must have the correct size. Expected iOS sizes can be found here. The size of an action bar icon on Android is fixed at 24dp (both width and height).
- type: Image
IconText¶
If Icon is absent or fails to download and if Caption property is missing, IconText property is used to render a
text-based Avatar image.
- type:
string
IsIconCircular¶
This determines if the Icon image and/or text-image of IconText should be circular in shape.
- type:
boolean - default:
false
OnPress¶
Action/Rule to be triggered when the item is pressed.
- type: ActionOrRule
- Formatter and Binding are not supported
Position¶
Position of the item in the ActionBar. For Android, this is ignored and all items will be placed on the right position except in modal page which allow one item to be on the left. For the left ActionBar item on modal page, only system item and icon / image are supported.
- type:
enum
The value of this property must be equal to one of the known values below.
Position Known Values¶
| Value | Description |
|---|---|
Left |
|
Right |
Style¶
The string value is a style class name for Icon and IconText. The style is applicable to SAP icon / font icon types
(Supported CSS properties are font-size and color) and text for the IconText attribute (Supported CSS properties are
font-size, color, and background-color).
- type:
string
SystemItem¶
SystemItem are built-in icons/text that represent common tasks and types of content in a variety of use cases. If
present, overwrites Caption and Icon.
- type: SystemItem
Visible¶
Set the visibility of this control.
- type:
boolean - default:
true
_Name¶
- type:
string