Show TOC

TriStateCheckBox PropertiesLocate this document in the navigation structure

Use

  • activateAccessKey

    Activates access keys.

    Both users and administrators can personalize this property.

  • checked

    Describes whether the UI element is selected.

    Note

    Use the type WDUI_TRI_STATE as the context attribute type.

    Primary Property

    You can also predefine values; see Methods and Properties of UI Elements.

    Value

    Example of the Visual Display

    Description

    Can Be Set Using Personalization

    false

    TriStateCheckBox.checked = false

    Option is not selected and the graphic is displayed on the user interface without a checkmark.

    Yes

    true

    TriStateCheckBox.checked = true

    Option is selected and the graphic is displayed on the user interface with a checkmark.

    Yes

    undecided

    TriStateCheckBox.checked = undecided

    Option is provided with a small star which indicates that you can decide to select the option or not.

    Yes

  • explanation

    Help text displayed when the help mode is activated. See also Help Texts in and for Web Dynpro Applications

    This property can be personalized by administrators.

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 the TriStateCheckBox or whether it only is 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 Truncating Contents in the FormLayout.

    Value

    Example of the Visual Display

    Description

    normal

    TriStateCheckBox.state = normal

    Normal status of the interface element

    required

    TriStateCheckBox.state = required

    The value must be entered

  • text

    Label text that is displayed as the explanatory text within the TriStateCheckBox.

    This property can be personalized by administrators.

  • 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