ToolBarInputField API
Definition
The ToolBarInputField-element represents an input field in a toolbar. It enables the user to enter or display a single-line text in the toolbar.
Description of UI Element Properties
● alignment
Specifies the horizontal alignment of the UI element in the grid. The default value of this property is auto. The alignment property can take the following values and is represented by the list type WDInputFieldAlignment:
auto |
The alignment is specified by the usage of the UI element - for example, by the displayed data type. |
left |
The content is displayed left-aligned. |
right |
The content is displayed right-aligned. |
● collapsible
This property enables you to assign the ToolBarInputField element to another UI element as a label.
● labelText
Specifies the label text.
● length
Determines the maximum number of characters to be displayed in the input field.
● passwordField
Boolean value that controls the display of entered characters on screen. If the value is true, the entered characters on screen are echoed with an asterisk (*). This attribute is usually used for password input fields.
● readOnly
Specifies whether the input field can be edited or only read. If the value is true, the displayed text can only be read.
● state
state is not supported. The state required will not be visualized.
● textDirection
Specifies the text direction and allows you to use input fields 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.
● value
Specifies the character string displayed in the input field area. This property must be bound to a context attribute (see Data Binding of UI Element Properties).
● width
Determines the width of the input field that you can specify in CSS sizes, such as em, ex, pixels or percentage values.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
alignment |
IWDAbstractInputField |
WDInputFieldAlignment |
auto |
bindable |
No |
collapsible |
IWDToolBarDropDownByIndex |
Boolean |
false |
bindable |
No |
enabled |
IWDUIElement |
boolean |
true |
bindable |
No |
labelText |
IWDToolBarInputField |
String |
|
bindable |
No |
length |
IWDAbstractInputField |
int |
20 |
bindable |
No |
passwordField |
IWDAbstractInputField |
boolean |
false |
bindable |
No |
readOnly |
IWDAbstractInputField |
boolean |
false |
bindable |
No |
state |
IWDAbstractInputField |
WDState |
normal |
bindable |
No |
textDirection |
IWDAbstractInputField |
WDTextDirection |
inherit |
bindable |
No |
tooltip |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
value |
IWDAbstractInputField |
String |
|
bindable_mandatory |
No |
visible |
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
width |
IWDAbstractInputField |
String |
|
bindable |
No |