Show TOC

CheckBoxGroup PropertiesLocate this document in the navigation structure

Use

  • 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 CheckBox 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 property can be personalized by administrators. In personalization, this property can be assigned the value: true

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:

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.

  • If displayOnly = true is set for UI elements DropDownByIndex, DropDownByKey, DropDownListBox, and InputField, multiple neighboring blank characters may be compressed to one single blank character when you run the application in Internet Explorer. The problem occurs in quirks mode with all IE versions and in standard mode with IE8 and smaller.

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

  • readOnly

    Specifies whether the user can select CheckBoxes in the CheckBoxGroup, 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

  • state

    Error status of the interface element. Read the note about the required asterisk for a Label in FormLayout under TTruncating Contents in the FormLayout.

    This property can be personalized by administrators.

    Value

    Visualization

    Description

    Can be Set Using Personalization

    normal

    CheckBoxGroup.state = normal

    Normal status of the interface element

    No

    required

    CheckBoxGroup.state = required

    The value must be entered.

    The CheckBoxGroup is displayed with a star.

    Note

    This value of thestate property is not checked by Web Dynpro Framework. Service functions are still available for checking required entries, see also SAP Note 948753 Information published on SAP site.

    Yes

  • 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

  • texts

    Specifies the path of the context attribute within a context node whose node elements provide the texts of the individual CheckBoxes at runtime.

    If you only want to select individual CheckBox entries, you require a node with the node attributes enabled (of type WDY_BOOLEAN) and texts in the context. You can then deactivate individualCheckBoxes by binding enabled on the same node as texts.

    Primary Property

  • 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:

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.

  • 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:

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.