TextEdit API
Definition
UI element 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.
If the value of property 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:
Description of UI Element Properties
- cols
Specifies the width of UI element TextEdit as a number of characters. - width
Specifies the width of the UI element and can be specified in CSS units like em, ex, pixels, or percentage. This property value overwrites the value of property row. - 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. Property wrapping can take the following values and is represented by enumeration type WDTextWrapping.
hard |
Wraps the text if the value specified by the col property is reached. A carriage control is inserted for each wrap. A horizontal scroll bar is not displayed for this value. |
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.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
cols |
IWDTextEdit |
int |
40 |
bindable |
No |
height |
IWDTextEdit |
String (CSS size) |
|
bindable |
No |
enabled |
IWDUIElement |
boolean |
true |
bindable |
No |
readOnly |
IWDTextEdit |
boolean |
false |
bindable |
No |
rows |
IWDTextEdit |
int |
5 |
bindable |
No |
state |
IWDTextEdit |
WDState |
Normal |
bindable |
No |
tooltip |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
value |
IWDTextEdit |
String |
|
bindable_mandatory |
No |
visible |
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
width |
IWDTextEdit |
String (CSS size) |
|
bindable |
No |
wrapping |
IWDTextEdit |
WDTextWrapping |
soft |
bindable |
No |