Input Field

The InputField UI element allows the user to edit or display a single-line text. You cannot only edit the value of the type String but also the value of any simple data type using an input field. The conversion of the string representation into the data type – known as parsing – and the conversion of the data type into the string presentation – known as formatting – are automatically executed. When using an InputField, you must always add a label to ensure accessibility.

Description of UI Element Properties

activateAccessKey

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

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 enumeration type WDInputFieldAlignment:

Value	Description
auto	The alignment is specified by the usage of the UI element - for example, by the displayed data type.
beginOfLine	The text content is always displayed at the beginning of line. Therefore, the text content for the value ltr of the textDirection property is left-justified. The text content for the value rtl is right-justified.
center	Centered alignment.
endOfLine	The text content is always displayed at the end of the line. Therefore, the text content for the value ltr of the textDirection property is right-justified. The text content for the value rtl is left-justified.
forcedLeft	The text content is always left-justified, regardless of whether the value is ltr or rtl for the textDirection property.
forcedRight	The text content is always right-justified, regardless of whether the value is ltr or rtl for the textDirection property.
left	Left-justified alignment. This value is deprecated. Use beginOfLine instead.
right	Right-justified alignment. This value is deprecated. Use forcedRight instead.

defaultDateRefId

You can use this property to refer to another date field for example in start/end date scenario. The date of the referred date field is used to initialize the date picker if the date field has no own value.

displayAsText

Specifies, whether the input field looks like a text if it has not the focus.

displayLabelAsDefault

This property is deprecated, use inputPrompt instead.

explanation

determines the explanation text. More information: Explanation

imeMode

An Input Method Editor (IME) allows users to enter and edit Chinese, Japanese, and Korean characters. The IME is an essential component for writing Chinese, Japanese, and Korean scripts. These writing systems have more characters than can be encoded for a regular keyboard. The IMEs for these languages use sequences of base characters that describe an individual character or group of characters to enter a larger set of characters. Base characters can be component letters from Hangul syllables, phonetic components for Japanese Kanji characters, or various combinations for Chinese characters. To compose text with an IME, the user generally uses dictionary lookup and contextual analysis, especially in languages where homonyms are frequent, as in Japanese. A user typically starts by entering a few component characters, optionally selecting from various choices, and a confirmation command.

inputPrompt

Specifies the text that is displayed if the input field has no initial value.

length

Specifies the maximum number of characters to be displayed in the input field.

onEnterBehavior

The onEnterBehavior property can be filled with the following values and is represented by the enumeration type WDOnEnterBehavior. Value default stands for the default behavior which is compatible to older releases. That means that the onEnter event is fired when the user selects an entry out of a proposal list or a suggestion list. Using value noEnterOnSelection means that if the user selects an entry out of a proposal list or a suggestion list, then no onEnter event is fired.

passwordField

Boolean value that controls the display of entered characters on the 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 read only. If the value is true, the displayed text can only be read.

size

This property is deprecated.

state

Describes the state of the UI element. The data type of this property corresponds to the enumeration type WDState.

suggestValues

Specifies whether suggest values are displayed while the user enters data. Prerequisite is that the input field is bound to a data type for which value help is provided.

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.

value

Specifies the character string displayed in the input field area. This property must be bound to a context attribute.

width

Specifies the width of the input field that you can specify in CSS sizes, such as em, ex, pixels or percentage values.

The element provides the events onEnter which is triggered when the user presses the Enter key. The event can be disabled by setting the property onEnterBehavior to noEnterOnSelection. The second event is onChange which is triggered when the input field looses focus and the value has been changed.

You can use the value property to bind data to an input field by assigning the path of the context attribute to this property.