Text area interface

Hierarchy

Properties

Classes: string[]

Additional CSS classes to add to the control.

Enabled: boolean

Enabled state of the UI element. When the type supports this, the UI element will be disabled when set to false.

Id: string

The id of the UI element.

Name: string

Name of the UI element. For form fields that would be the name otherwise used for reference only.

OnBlur: ((textArea) => void)

Type declaration

    • (textArea): void
    • Event gets fired when the text area loses focus.

      Parameters

      Returns void

OnChange: ((textArea) => void)

Type declaration

    • (textArea): void
    • Event gets fired when the value of the text area changes.

      Parameters

      Returns void

OnFocus: ((textArea) => void)

Type declaration

    • (textArea): void
    • Event gets fired when the text area gets focus.

      Parameters

      Returns void

OnKeyDown: ((textArea, event) => void)

Type declaration

    • (textArea, event): void
    • Event gets fired when a key is pressed

      Parameters

      • textArea: MEUITextArea

        The text area which key was pressed.

      • event: KeyboardEvent

        The keyboard event which was fired.

      Returns void

OnKeyUp: ((textArea, event) => void)

Type declaration

    • (textArea, event): void
    • Event gets fired when a key is released

      Parameters

      • textArea: MEUITextArea

        The text area which key was released.

      • event: KeyboardEvent

        The keyboard event which was fired.

      Returns void

ParentClasses: string[]

Additional CSS classes to add to the parent control when supported.

Placeholder: string

The placeholder text shown when there is no value.

RichTextFontArray: string[]

The list of available fonts to use. Must be the font family names and all fonts must be available for the editor to use. Only valid if rich text is supported.

Size?: MEUISize

The size of the UI element.

StandardClasses: string[]

The standard classes of the control. Modify this property only if you know what you are doing.

SupportBold: boolean

Flag indicating if the text area supports bold text. Note that all fonts must support those variants. Only valid if rich text is supported.

SupportFont: boolean

Flag indicating if the text area supports font family changes. Please provide a list of supported fonts in RichTextFontArray. Only valid if rich text is supported.

SupportFontSize: boolean

Flag indicating if the text area supports font size changes. Only valid if rich text is supported.

SupportItalic: boolean

Flag indicating if the text area supports italic text. Note that all fonts must support those variants. Only valid if rich text is supported.

SupportRichText: boolean

Flag to indicate if the text area supports rich text.

SupportUnderline: boolean

Flag indicating if the text area supports underline formatting. Only valid if rich text is supported. Only valid if rich text is supported.

Tags: string[]

Tags for the UI element. Used for reference only.

TextDirection: TextFieldTextDirection

The text direction of the UI element. Defaults to Inherit, meaning it will use the editor default.

ToolTip?: string

Tooltip text of the UI element.

Type: "TextArea" | "RichText"

The type of the UI element. Either "TextArea" or "RichText".

Value: string

The current value of the control.

ValueHtmlEncoded: string

The html encoded version of the value.

Visible: boolean

Visibility flag of the UI element. When not visible it will be hidden from the UI.

Generated using TypeDoc