Class Textarea

Represents a multiline text input control.

There is no limit on the input length, allowing for extensive text entries. This control is ideal for scenarios where users may need to provide detailed information, such as comments or descriptions.

Hierarchy

  • UpDataEditControl
    • Textarea

Properties

element

Accessors

required

Methods

checkValidity getValue setValue

Properties

element

element: HTMLTextAreaElement

Accessors

required

  • get required(): boolean

  • Gets the required state of the control.

    Returns boolean

    Example

    var textarea = ix.api.dom.getControl("<ELEMENT-GUID>");
    textarea.required;
  • set required(value): void

  • Sets the required state of the control.

    Parameters

    • value: boolean

    Returns void

    Example

    var textarea = ix.api.dom.getControl("<ELEMENT-GUID>");
    textarea.required = <true|false>;

Methods

checkValidity

  • Checks the elements validity.

    Returns Promise<ValidationInfo>

    Example

    const validityResult = await ix.api.dom.getControl("<ELEMENT-GUID>").checkValidity();

    // example of `validityResult` - the entered value has wrong format
    ValidationInfo {
      valStatus: false,
      valMessage: 'The field must not be empty.',
      valType: 'required'
    }

getValue

  • Gets the value of the control.

    Returns string

    Example

    var textarea = ix.api.dom.getControl("<ELEMENT-GUID>");
    textarea.getValue();

setValue

  • Sets the value of the control.

    Parameters

    • value: string
    • Optional settings: {
          triggerOnchange: "disabled" | "strict" | "always";
      }
      • triggerOnchange: "disabled" | "strict" | "always"

    Returns void

    Example

    var textarea = ix.api.dom.getControl("<ELEMENT-GUID>");
    textarea.setValue("my value");

Settings

Member Visibility

Theme

On This Page