You are here:
TextBar Control
Use TextBar to define additional information, which acts as an aid for the app user to perform the necessary tasks related to the list. TextBar is rendered at the top of the GroupedList and above the SearchBar.
Required Editions
| Available in Lightning Experience in Professional, Unlimited, and Enterprise Editions that have Consumer Goods Cloud enabled. |
Considerations for using TextBar:
- Textbar subnode enables you to add an additional headerline to the
GroupedListcontrol. TheGroupedListcontrol supports only one additional headerline. - TextBar control is supported only within the GroupedList element of the UI contracts.
- You can specify only one TextBar control in a GroupedList element.
- TextBar control grows dynamically to support multiple lines of text. It is a single-line text control with automatic wrapping.
- TextBar control is secured against HTML injection as the text displayed through the text binding is HTML sanitized.
The table describes the only attribute supported by the TextBar control.
| Attribute | Description | Values/Pattern | Required |
|---|---|---|---|
| name | Unique name used to identify the text bar. | String | Yes |
The TextBar element can contain the Bindings subelement. The Bindings subelement consists of the Resource and Binding elements. The table lists the targets supported for the Resource and Binding elements in the TextBar control.
| Element | Description | Required |
|---|---|---|
| backgroundColor | Specifies the background color for the text bar. The default background color for the text bar is Textbar_Background. | No |
| fontColor | Specifies the text font color for the text bar. The default font color for the text bar is Textbar_Font. | No |
| text | Specifies the text to be displayed in the text bar. The text supports the [b]...[/b] pattern to print bold text. | Yes |
Sample TextBar definition
<GroupedList>
<TextBar name="TextBar1">
<Bindings>
<Binding target="backgroundColor" type="Color" binding="ProcessContext::MainBo.TextBarBackgroundColor" bindingMode="ONE_WAY"/>
<Binding target="fontColor" type="Color"
binding="ProcessContext::MainBo.TextBarFontColor" bindingMode="ONE_WAY"/>
<Binding target="text" type="Text" binding="ProcessContext::MainBo.TextBarText"
bindingMode="ONE_WAY" />
</Bindings>
</TextBar>
</GroupedList>Did this article solve your issue?
Let us know so we can improve!
