Show TOC

 DropDownByKeyLocate this document in the navigation structure

Definition

A DropDownByKey UI element provides the user with a selection list from which he or she can select no more than one entry. The UI element consists of a text field, a button, and a selection list. Any list entry already selected is displayed in the text field. When you select the pushbutton, a list with all possible values is displayed.

Visual Display

Note

When using a dropdown list box, always display this UI element alongside a Label UI element (that is, an element with a label) to ensure accessibility.

Description of UI Element Properties
  • explanation

    determines the explanation text. explanation is maintained by the documentation developer in the Web Dynpro Authoring environment.

  • labelFor

    The DropDownByKey element can also be used as a label for other UI elements. You can use the labelFor property to reference to a UI element.

  • readOnly

    specifies whether the user can select an element.

  • selectedKey

    determines the value from a value set. The value is selected from the DropDownByKey list.

  • size

    This property is deprecated and can no longer be used.

  • state

    Describes whether an icon that indicates a required state is displayed. state can take the following values and is represented by enumeration type WDState:

    • normal
    • required. The required state will be displayed by an asterisk.
  • textDirection

    Specifies the text direction. This enables the labels for the DropDownByKey to be read in other languages that require a specific text direction. The textDirection property can take the following values and is represented by enumeration type WDTextDirection.

    inherit

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

    ltr

    The text runs from left to right.

    rtl

    The text runs from right to left.

    The default value for this property is inherit.

  • width

    Determines the width of the DropDownByKey. You can specify this in CSS sizes, such as em, ex, pixels or percentage values.

Properties Overview
Name Interface Type Initial Value Bindable

enabled

IWDUIElement

boolean

true

bindable

explanation

IWDDropDownByKey

String

 

not_bindable

labelFor

IWDAbstractDropDown

String

 

not_bindable

readOnly

IWDAbstractDropDown

boolean

false

bindable

selectedKey

IWDAbstractDropDownByKey

String

 

bindable_mandatory

size

IWDDropDownByKey

WDDropDownListBoxSize

standard

bindable

state

IWDAbstractDropDown

WDState

normal

bindable

textDirection

IWDAbstractDropDown

WDTextDirection

inherit

bindable

tooltip

IWDUIElement

String (TranslatableText)

 

bindable

visible

IWDUIElement

WDVisibility

visible

bindable

width

IWDAbstractDropDown

String

 

bindable

Events
  • onSelect

    This event is triggered when the user selects a list entry from the dropdown list box.

    Event Parameter Type Description

    key

    String

    Key of the selected entry.