Class Textarea

Represents a multiline text view control.

It provides a user-friendly interface for displaying multiline text data. It ensures that the text is formatted correctly for display and is easily readable by the user. This control is ideal for scenarios where users may need to view detailed information, such as comments or descriptions.

Note

This control also serves as a view control, displaying the content from the Content Editor.

Hierarchy

  • UpTextVMainControl
    • Textarea

Accessors

displayValue

Methods

getValue setValue

Accessors

displayValue

  • get displayValue(): string

  • Returns the value displayed to the user. It's not always the value which was saved.

    Therefor use getValue.

    Returns string

    Example

    // Get display value
    ix.api.dom.getControl("<ELEMENT-GUID>").displayValue;

Methods

getValue

  • Retrieve the current value of the control.

    Returns string

    Example

    // Get value of control
    ix.api.dom.getControl("<ELEMENT-GUID>").getValue();

setValue

  • Set value of the control.

    Parameters

    • value: string
    • Optional settings: {
          asHtml?: boolean;
      }

      Optional configuration options for setting the value.

      • asHtml: Determines whether the value should be treated as HTML (true) or plain text (false).
      • Optional asHtml?: boolean

    Returns void

    Example

    // Set value as text
    ix.api.dom.getControl("<ELEMENT-GUID>").setValue("INTREXX!");
    // Set value as HTML
    ix.api.dom.getControl("<ELEMENT-GUID>").setValue("Hey <strong>INTREXX!</strong>", { asHtml: true });

Settings

Member Visibility

Theme

On This Page