Show TOC Start of Content Area

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

Definition

ToolBarInputField 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

      activateAccessKey

Indicates whether access key for this control is 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 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.

      defaultDateRefId

specifies the Id of another input field, whose date is initialized with the value of this ToolBarInputField, if it has no own value.

      displayAsText

Specifies whether the ToolBarInputField looks like a text if it hasn’t the focus.

      displayLabelAsDefault

Specifies whether the associated label’s text is displayed as default value of this ToolBarInputField, if the value is null.

      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.

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.

      value

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

      width

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

Properties Overview

Name

Interface

Type

Initial Value

Bindable

activateAccessKey

IWDAbstractInputField

boolean

false

not bindable

alignment

IWDAbstractInputField

WDInputFieldAlignment

auto

bindable

collapsible

IWDToolBarDropDownByIndex

Boolean

false

bindable

defaultDateRefId

IWDAbstractInputField

String

 

not bindable

displayAsText

IWDAbstractInputField

boolean

false

bindable

displayLabelAsDefault

IWDAbstractInputField

boolean

false

bindable

enabled

IWDUIElement

boolean

true

bindable

labelText

IWDToolBarInputField

String

 

bindable

length

IWDAbstractInputField

int

20

bindable

passwordField

IWDAbstractInputField

boolean

false

bindable

readOnly

IWDAbstractInputField

boolean

false

bindable

state

IWDAbstractInputField

WDState

normal

bindable

textDirection

IWDAbstractInputField

WDTextDirection

inherit

bindable

tooltip

IWDUIElement

String (TranslatableText)

 

bindable

value

IWDAbstractInputField

String

 

bindable_mandatory

visible

IWDUIElement

WDVisibility

visible

bindable

width

IWDAbstractInputField

String

 

bindable

Events

      onChange

This event is triggered when the InputField loses focus and the value has been changed.

End of Content Area