ToolBarDropDownByKey
Definition
The ToolBarDropDownByKey represents a DropDownByKey element in a ToolBar. In addition to the DropDownByKeyelement, it can be collapsed.
Description of UI Element Properties
● activateAccessKey
Indicates whether access key for this control is activated. More information: Enabling Access Keys.
● collapsible
Specifies whether the ToolBar element can be collapsed. A little icon is displayed in a ToolBar which contains those elements. When the user selects this icon, all toolbar elements with the collapsible property set to true are hidden.
● displayAsText
Specifies whether the ToolBarDropDownByKey looks like a text if it has not the focus.
● keyVisible
Specifies whether the keys are displayed with the texts in the ToolBarDropDownByKey.
● labelFor
This property enables you to assign the ToolBarDropDownByKey element to another UI element as a label.
● labelText
Specifies the label text.
● readOnly
Specifies whether the user can modify the selection in the ToolBarDropdownByKey.
● selectedKey
Describes the key that specifies the selection of the ToolBarDropdownByKey.
● selectionChangeBehaviour
The selectionChangeBehaviour property can be filled with the following values and is represented by the enumeration type WDLeadSelectionChangeBehaviour.
auto |
Specifies that the UI element automatically changes the lead selection after an interaction by the user before the corresponding event is triggered. |
manual |
Specifies that the UI element does not change the lead selection 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 UI element to display the data. This setting allows you to check the change of the lead selection. |
● state
Describes the status of the ToolBarDropdown list box. The data type of this property corresponds to the enumeration type WDState. You can use the following values in the application:
normal |
Describes the default state of the UI element. |
required |
Indicates that value selection is mandatory. |
● suggestValues
specifies whether suggestion is enabled, if the ToolBarDropDownByKey is bound to data type that has a value help.
● textDirection
Specifies the text direction and allows you to use dropdown list boxes for texts in languages which require a specific text direction. The textDirection property can be filled with the following values and is represented by the enumeration type WDTextDirection.
The text direction is inherited from the parent element. Therefore, the text direction is identical to the one of the parent element. |
|
The default value for this property is inherit.
● width
Specifies the width of the dropdown list box and can be specified in CSS units like em, ex, pixels, or percentage.
Properties Overview
Name |
Interface |
Type |
Initial Value |
Bindable |
activateAccessKey |
IWDAbstractDropDown |
boolean |
false |
not bindable |
collapsible |
IWDToolBarDropDownByKey |
boolean |
false |
bindable |
displayAsText |
IWDAbstractDropDown |
boolean |
false |
bindable |
enabled |
IWDUIElement |
boolean |
true |
bindable |
labelFor |
IWDAbstractDropDown |
String |
|
not_bindable |
labelText |
IWDToolBarDropDownByKey |
String |
|
bindable |
readOnly |
IWDAbstractDropDown |
boolean |
false |
bindable |
selectedKey |
IWDAbstractDropDownByKey |
boolean |
false |
bindable_mandatory |
selectionChangeBehaviour |
IWDAbstractDropDownByKey |
WDLeadSelectionChangeBehaviour |
auto |
not_bindable |
state |
IWDAbstractDropDown |
WDState |
normal |
bindable |
suggestValues |
IWDAbstractDropDownByKey |
boolean |
false |
not bindable |
textDirection |
IWDAbstractDropDown |
WDTextDirection |
inherit |
bindable |
tooltip |
IWDUIElement |
String |
|
bindable |
visible |
IWDUIElemente |
WDVisibility |
visible |
bindable |
width |
IWDAbstractDropDown |
String |
|
bindable |