Show TOC

 TextEditLocate this document in the navigation structure

Definition

TextEdit makes it possible to enter and display multi-line text. The text in this UI element uses a uniform font, font size, and font style. The UI element is displayed with borders and the frame size is specified by the properties col and row. If the number of rows exceeds the value of property row, a vertical scroll bar is displayed.

Note

If the value of wrapping is off, the scroll bar is only displayed if the text row length exceeds the value of property col .

The following graphic shows UI element TextEdit in the SAP standard design:

TextEdit

Description of UI Element Properties
  • activateAccessKey

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

  • adjustRowsToText

    Specifies, whether this TextEdit should adjust the number of rows to the text, which is displayed.

  • cols

    Specifies the width of UI element TextEdit as a number of characters.

  • displayAsText

    Specifies, whether the TextEdit looks like a TextView if it has not the focus.

  • explanation

    determines the explanation text. More information: Explanation

  • readOnly

    Specifies whether or not text can be entered in the UI element.

  • rows

    Specifies the height of UI element TextEdit as a number of characters.

  • state

    Describes the state of UI element TextEdit. Property state can take the following values and is represented by enumeration type WDState.

    normal

    Describes the default state of the UI element.

    required

    Specifies whether the entered value is required.

  • value

    Describes the text to be displayed. The text can be edited.

  • wrapping

    Specifies whether or not the text can be wrapped. wrapping can take the following values and is represented by enumeration type WDTextWrapping.

    hard

    deprecated

    off

    The text is not wrapped. If the text row length exceeds the width specified by property col, a horizontal scroll bar is displayed.

    soft

    Wraps the text if the value specified by attribute col is reached. A carriage control is not inserted for wrapping, and a horizontal scroll bar is not displayed for this value.

  • width

    Determines the width of the UI element that you can specify in CSS sizes, such as em, ex, pixels or percentage values. This property value overwrites the value in property row.

Properties Overview
Name Interface Type Initial Value Bindable

activateAccessKey

IWDTextEdit

boolean

false

not bindable

adjustRowsToText

IWDTextEdit

boolean

false

bindable

cols

IWDTextEdit

int

40

bindable

displayAsText

IWDTextEdit

boolean

false

bindable

enabled

IWDUIElement

boolean

true

bindable

explanation

IWDTextEdit

String

 

not_bindable

height

IWDTextEdit

String (CSS size)

 

bindable

readOnly

IWDTextEdit

boolean

false

bindable

rows

IWDTextEdit

int

5

bindable

state

IWDTextEdit

WDState

Normal

bindable

tooltip

IWDUIElement

String (TranslatableText)

 

bindable

value

IWDTextEdit

String

 

bindable_mandatory

visible

IWDUIElement

WDVisibility

visible

bindable

width

IWDTextEdit

String (CSS size)

 

bindable

wrapping

IWDTextEdit

WDTextWrapping

soft

bindable

 

Events
  • onChange

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