Show TOC

 FormattedTextEdit Locate this document in the navigation structure

Definition

A FormattedTextEdit UI Element represents an edit box for formatted text. User input is automatically transformed into the corresponding tags. The user has the following subset of formatting options:

icon display equivalent in XHTML description

<strong>

bold

<em>

Italic

<h1>

header 1

<h2>

header 2

<h3>

header 3

<blockquote>

increase indent

</blockquote>

decrease indent

<ol>

numbered list

bulletedlist

<ul>

bulleted list

Description of UI Element Properties
  • height

    Determines the height of the FormattedTextEdit, that you can specify in relative CSS units like em or ex.

  • imeMode

    An Input Method Editor (IME) allows users to enter and edit Chinese, Japanese, and Korean characters. The IME is an essential component for writing Chinese, Japanese, and Korean texts. These writing systems have more characters than can be encoded for a regular keyboard. The IMEs for these languages use sequences of base characters that describe an individual character or group of characters to enter a larger set of characters. Base characters can be component letters from Hangul syllables, phonetic components for Japanese Kanji characters, or various combinations for Chinese characters.

    To compose text with an IME, the user generally uses dictionary lookup and contextual analysis, especially in languages where homonyms are frequent, like Japanese. A user typically starts by entering a few component characters, optionally selecting from various choices, and a confirmation command.

    Property imeMode can take the following values and is represented by enumeration type WDIMEMode:

    • auto (default)
    • active
    • inactive
    • disabled
  • readOnly

    Specifies whether the FormattedTextEdit can be edited or read only. If the value is true, the displayed text can be read but is write-protected.

  • showFormattingOptions

    Specifies whether the toolbar with the formatting options is displayed.

  • textDirection

    Specifies the text direction and allows you to use input fields for texts in languages that require a specific text direction. The textDirection property can take the following values and is represented by enumeration type WDTextDirection.

    inherit

    The text direction is inherited from the parent element. The text direction is therefore identical to that of the parent element.

    ltr

    The text runs from left to right.

    rtl

    The text runs from right to left.

    The default is inherit.

  • value

    Specifies the formatted text displayed in the FormattedTextEdit. This property must be bound to a context attribute of type FormattedText.

  • width

    Determines the width of the FormattedTextEdit and can be specified in CSS sizes, such as em, ex, pixels or percentage values.

Properties Overview
Name Interface Type Initial Value Bindable
Enabled IWDUIElement boolean true bindable
Height IWDFormattedTextEdit String   bindable
imeMode IWDFormattedTextEdit WDIMEMode auto bindable
readOnly IWDFormattedTextEdit boolean false bindable
textDirection IWDFormattedTextEdit WDTextDirection inherti bindable
Tooltip   String (Translatable Text)   bindable
Value IWDFormattedTextEdit IWDFormattedTextEdit   bindable_mandatory
Visible IWDUIElement WDVisibility visible bindable
Width IWDFormattedTextEdit String   bindable
Events
  • onChange

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