Show TOC

Background documentationTextEdit Locate this document in the navigation structure

 

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 wrapping is off, the scroll bar is only displayed if the text row length exceeds the value of property col.

Description of 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 has a number of characters.

state

Describes the state and can take the values normal and required. The property is represented by enumeration type WDState.

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 values off and soft and is represented by enumeration type WDTextWrapping.

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.

Events

onChange

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