ItemListBox API 

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.

Description of UI Element Properties

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

·        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 textDirectionproperty 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.

·        iconSource
This property describes the Web address (URL) of the graphic to be displayed.

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

Overview of Inherited and Additional Properties

Name	Interface	Type	Initial Value	Bindable	Value Required
dataSource	IWDItemListBox	Object		bindable_mandatory	No
descriptiveText	IWDItemListBox	String		bindable	No
descriptiveTextDirection	IWDItemListBox	WDTextDirection	inherit	bindable	No
enabled	IWDUIElement	boolean	true	bindable	No
explanation	IWDItemListBox	String		not_bindable	No
iconSource	IWDItemListBox	String		bindable	No
multipleSelection	IWDItemListBox	boolean	false	bindable	No
readOnly	IWDItemListBox	boolean	false	bindable	No
selectionChangeBehaviour	IWDItemListBox	WDLeadSelectionChangeBehaviour	auto	not_bindable	No
text	IWDItemListBox	String		bindable	No
textDirection	IWDItemListBox	WDTextDirection	inherit	bindable	No
tooltip	IWDUIElement	String		bindable	No
visible	IWDUIElement	WDVisibility	visible	bindable	No
visibleItems	IWDItemListBox	int	10	bindable	No
width	IWDItemListBox	String		bindable	No

Ereignisse

 

Events

·         onLeadSelect (int index)
Specifies the action that is executed when the user selects an element of the ItemListBox.