Text box 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: ((textBox) => void)

Type declaration

    • (textBox): void
    • Event gets fired when the text box loses focus.

      Parameters

      Returns void

OnChange: ((textBox) => void)

Type declaration

    • (textBox): void
    • Event gets fired when the value of the text box changes.

      Parameters

      Returns void

OnFocus: ((textBox) => void)

Type declaration

    • (textBox): void
    • Event gets fired when the text box gets focus.

      Parameters

      Returns void

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

Type declaration

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

      Parameters

      • textBox: MEUITextBox

        The text box which key was pressed.

      • event: KeyboardEvent

      Returns void

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

Type declaration

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

      Parameters

      • textBox: MEUITextBox

        The text box which key was released.

      • event: KeyboardEvent

      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.

StandardClasses: string[]

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

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: "TextBox"

The type of the UI element. Always "TextBox".

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