Show TOC

Background documentationRadioButtonGroupByKey Properties Locate this document in the navigation structure

 

  • accessibilityDescription

    If you have activated accessibility, the assigned text is added to the quick info. This description provides semantic details of the UI element, and is only read by the screen reader if the user focuses the complete Ul element.

    This property can be personalized by administrators.

  • activateAccessKey

    Activates access keys.

    Both users and administrators can personalize this property.

  • colCount

    Specifies the number of columns in which the RadioButtonGroup elements are grouped.

    This property can be personalized by administrators.

  • displayOnly

    Specifies whether the user can edit the UI element or only display it.

    This property has almost the same function as readOnly. The differences are that the background of UI elements is white instead of gray, and any required asterisk is no longer displayed on the label after activation.

    The following figure shows this difference, using the RadioButton UI element as an example:

    This graphic is explained in the accompanying text.

    This property can be personalized by administrators. In personalization, this property can be assigned the value: true

Caution Caution

If you use displayOnly with the following UI elements, not all properties are supported.

The supported properties are listed below:

  • displayOnly for the UI element InputField:

    If you use displayOnly for the UI element InputField, only the following properties are supported:

  • displayOnly for the UI element DropDownByIndex or DropDownByIndex:

    If you use displayOnly for UI elements DropDownByIndex and DropDownByIndex, only the following properties are supported:

End of the caution.

Note Note

  • If both displayOnly = true and readOnly = true are used, the UI element is displayed in displayOnly- style.

  • A TextView is rendered for UI elements InputField, DropDownByKey, DropDownByIndex, and DropDownListBox if displayOnly = true.

  • Property displayOnly does not function in ToolBar elements.

End of the note.

Note Note

End of the note.

  • explanation

    Help text displayed when the help mode is activated. See also Explanation.

    This property can be personalized by administrators.

Note Note

The explanation iproperty is only displayed if a Label exists for the corresponding UI element.

Note the following exception:

The explanation property of an AbstractTableColumn is always displayed. If the UI element appears in a Table, and therefore has no Label, then use a AbstractTableColumn.explanation as a replacement for an explanation for the respective UI element (for example, InputField).

End of the note.

  • keyVisible

    The keys are also listed in the RadioButtonGroup box.

    Note Note

    Note that this property is not API-visible, that means it cannot be changed by application developers.

    End of the note.

  • readOnly

    Specifies whether the user can select RadioButtons in the RadioButtonGroup, or whether they are to be displayed as read-only.

    This property can be personalized by administrators. In personalization, this property can be assigned the value: true

  • selectedKey

    Value from the value set that is selected in the list displayed in the RadioButtonGroup.

    Primary Property

  • state

    Input status. Read the note about the required asterisk for a Label in FormLayout under Truncating Contents in the FormLayout.

    This property can be personalized by administrators.

    Value

    Description

    Can be Set Using Personalization

    normal

    Normal status of the interface element

    No

    required

    The value must be entered

    Yes

  • textDesign

    This property defines the appearance of the text of a UI element.

    Value

    Description

    standard

    Default Value

    emphasized

    The text is emphasized.

    The following figure shows the text of a radio button if the value is emphasized, that is, the text is emphasized:

    This graphic is explained in the accompanying text.

Note Note

For the UI elements RadioButton, CheckBox, and TriStateCheckBox, textDesign is set for the respective text of the corresponding UI element.

For the UI elements RadioButtonGroupByIndex, RadioButtonGroupByKey, and CheckBoxGroup, textDesign is set for the text of all radio buttons and checkboxes contained in the group. This means that the value of textDesign is passed on to these elements. It is not possible to set different values for different radio buttons or checkboxes in a group.

End of the note.

  • textWrapping

    Value

    Description

    false

    Default Value

    true

    The text is wrapped (see figure).

    The following figure shows the text of a checkbox if the value is true, that is, the text is wrapped:

    This graphic is explained in the accompanying text.

Note Note

For the UI elements RadioButton, CheckBox, and TriStateCheckBox, textWrapping is set for the respective text of the corresponding UI element.

For the UI elements RadioButtonGroupByIndex, RadioButtonGroupByKey, and CheckBoxGroup, textWrapping is set for the text of all radio buttons and checkboxes contained in the group. This means that the value of textWrapping is passed on to these elements. It is not possible to set different values for different radio buttons or checkboxes in a group.

End of the note.

  • textDirection

    Text or writing direction.

    This enables labels of interface elements to be read in languages that have an RTL writing direction, such as Arabic or Hebrew, as opposed to LTR for languages like English.

    This property can be personalized by administrators.

    Value

    Description

    Can be Set Using Personalization

    INHERIT

    The text direction is inherited from the parent element. Therefore, the text direction is identical to that of the parent element.

    Yes

    LTR

    Left to right text direction

    Yes

    RTL

    Right to left text direction

    Yes

  • width

    Width of the UI element. See also Methods and Properties.

    This property can be personalized by administrators.