Show TOC Start of Content Area

Object documentation ItemListBox This graphic is explained in the accompanying text  Locate the document in its SAP Library structure

An ItemListbox provides different values for selection, similar to the DropDownBox. You can vary the number of displayed values and, in contrast to a DropDownBox, multiple selection is possible.

This graphic is explained in the accompanying text

Description of UI Element Properties

      activateAccessKey

Indicates whether access key for this control is activated. More information: Enabling Access Keys

      dataSource

This property is used to specify the data source. You can use it to specify the path to the context node providing the data.

      descriptiveText

This property defines a descriptive text that is displayed within the ItemListBox beside the text.

      explanation

determines the explanation text. More information: Explanation

      iconSource

defines the path to the image source.

More Information: Specifying the Image Source

      textDirection

This property specifies the text direction and allows you to use dropdown list boxes for texts in languages that require a specific text direction. The textDirection property can be filled with the following values and is represented by the listing type WDTextDirection.

inherit

The text direction is inherited from the parent element. Therefore, the text direction is identical to the one 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.

      multipleSelection

This property enables the selection of several elements.

      readOnly

This property controls whether the user can choose an element from the ItemListBox UI element.

      selectionChangeBehaviour

The change of the lead selection can cause a data loss – for example, if the changed or new data was not written to the context due to syntax errors. You can avoid the data loss using the selectionChangeBehaviour property before changing the lead selection:

auto

If the data was written to the context, the value auto specifies that the ItemListBox automatically changes the lead selection of its data source directly after an interaction by the user before the corresponding event is triggered.   

manual

Specifies that the ItemListBox does not change the lead selection of its data source after an interaction by the user but triggers the corresponding event. In this case, the event handler must change the lead selection to enable the ItemListBox to display the data in a main detail view, for example. This setting allows you to check the change of the lead selection.

      text

This property specifies the text to be assigned to the ItemListBox .

      textDirection

You can use this property to define the text direction. It thus enables the labels for all item list boxes to be read in other languages that require a specific text direction. The textDirection property can be filled with the following values and is represented by the listing type WDTextDirection.

inherit

The text direction is inherited from the parent element. Therefore, the text direction is identical to the one 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.

      visibleItems

This property defines the size of the item list box on the basis of the number of visible elements.

      width

This property specifies the width of the item list box and can be specified in CSS units like em, ex, pixels, or percentage.

Properties Overview

Name

Interface

Type

Initial Value

Bindable

activateAccessKey

IWDItemListBox

boolean

false

not bindable

dataSource

IWDItemListBox

Object

 

bindable_mandatory

descriptiveText

IWDItemListBox

String

 

bindable

descriptiveTextDirection

IWDItemListBox

WDTextDirection

inherit

bindable

enabled

IWDUIElement

boolean

true

bindable

explanation

IWDItemListBox

String

 

not_bindable

iconSource

IWDItemListBox

String

 

bindable

multipleSelection

IWDItemListBox

boolean

false

bindable

readOnly

IWDItemListBox

boolean

false

bindable

selectionChangeBehaviour

IWDItemListBox

WDLeadSelectionChangeBehaviour

auto

not_bindable

text

IWDItemListBox

String

 

bindable

textDirection

IWDItemListBox

WDTextDirection

inherit

bindable

tooltip

IWDUIElement

String

 

bindable

visible

IWDUIElement

WDVisibility

visible

bindable

visibleItems

IWDItemListBox

int

10

bindable

width

IWDItemListBox

String

 

bindable

Events

·         onLeadSelect (int index)

This event is triggered when the user selects an element of the ItemListBox.

·         onDrop (String data, int index, String mimeType, int offset, String tags)

This event is triggered when the user drops an object onto this ItemListBox. The parameters are:

       data: The data specified for the drag source.

       index: The index of the element the user has dropped the object onto.

       mimeType: the mime type specified for the drag source.

       offset: the position relative to the index, the user has dropped the object onto.

       -1: just above the item specified by the index

       0: right onto the item specified by the index

       +1: just below the item specified by the index.

       tags: the tags defined for the drag source

End of Content Area