Show TOC

Background documentationUsage & Type Locate this document in the navigation structure

 

The text edit control provides an area for multiple-row text editing.

This graphic is explained in the accompanying text.

Figure 1: Example of text edit control in an iView

This graphic is explained in the accompanying text.

Figure 2: Example of text edit control in an iView

Usage

Use the text edit control to allow users to edit multiple line of text.

The text is restricted to a single font, size and style unless set with HTML commands. The text edit control has a frame. The size of the frame is defined by the rows and cols attributes. A vertical scrollbar is displayed permanently. The scrollbar is enabled when the number of text lines exceeds the number of visible lines.

Alignment

There are two possible ways to align the text edit control:

  • Below a group of fields with a descriptive label above the text edit control (figure 1)

  • In line with other fields within a field group with a label to the left (figure 2)

Place the text edit below the field group if it is used as the main information, whereas the fields above it provide only the context for the information in the text edit control.

Example: A problem description when sending a problem message to a service center.

Place the text edit field within the field group if the information is just one piece of information among other information, and the text edit control is used as a freeform multiple-line input field.

Example: A customer enters his or her preferences when registering for an online shop.

Design-relevant Attributes

The text edit control can be influenced through a number of attributes:

  • The text and a tooltip text can bet set (attributes text and tooltip)

  • The number of rows and columns can be set (attributes rows and cols)

  • The wrapping behavior can be determined (attribute wrapping, values HARD, SOFT and OFF)

For details see Control API for the text edit control.

Related Controls

Text View