Label element

A label element represents a label on the UI, it can be the child element of a page, a fragment or a container element.

Syntax of the label element

label <label-id> {<label-descriptor>}


  • The <label-id> is the name of the label.

  • The <label-descriptor> defines the look of the label element.

Events of the label

The label is not an active UI element, but it supports following events:

  • valueChange: using this event, the label value can be changed.

Example event call to change the value of the label DescriptionLabel on page ExamplePage
1function changeTheValueOfTheLabelDescription(labelValue) {
2  fireEvent(createTargetEvent("DescriptionLabel", "onRefresh", labelValue), "ExamplePage");

Dictionary keys of the label

The UI values of the label element are in the dictionary. The corresponding key has the form of ‘page_<page-name>[_<fragments-and-container-structure-to-label>]_<label-id>_defaultText’.

Dictionary key definition for label example in the file
1page_ExamplePage_DescriptionLabel_defaultText=This is the UI value of the label with name DescriptionLabel

Syntax of the label descriptor

The label descriptor can contain one or more attribute descriptors.



  • Multiple <attirbute-descriptor> can be defined, the definitions are optionally separated by ‘,’ or ‘;’.

Syntax of the label’s attribute descriptor

<attirubte-name>: <attribute-value>


  • List of valid attribute names and values are defined by client device types below.

Valid label attribute names and values

The following table describes the valid attributes and its values for different client device types.

Valid values



Valid values



Defines the template to be used

display templates in 5 sizes ( N = 1..5): display<N>Primary, display<N>Secondary, display<N>Tertiary, display<N>Disabled; heading templates in 5 sizes ( N = 1..7): heading<N>Primary, heading<N>Secondary, heading<N>Tertiary, heading<N>Disabled; body-copy templates in 3 sizes ( N = 1..3): bodyCopy<N>Primary, bodyCopy<N>Secondary, bodyCopy<N>Tertiary, bodyCopy<N>Disabled; body-copy-condensed templates in 3 sizes ( N = 1..3): bodyCopy<N>CondensedPrimary, bodyCopy<N>CondensedSecondary, bodyCopy<N>CondensedTertiary, bodyCopy<N>CondensedDisabled

template: display1Primary,


Defines the spacing of the element, if missing, then auto sizing is set

Numbers, e.g.: 0

span: 0;

bold / isBoold

Defines if the font is bold or not

Boolean values: true or false

isBold: true;


Not supported anymore


Defines the alignment of the label

Valid values are ‘left’, ‘right’ and ‘center’

alignment: center;

Example label definition

The following code examples are defining a label and its value:

Example label definition on a page
1page ExamplePage {
2  layout: vertical;
3  template: fullscreen;
5  label DescriptionLabel {
6    template: display1Primary;
7  }
Dictionary key definition for the example label
1page_ExamplePage_DescriptionLabel_defaultText=Here and now!