===== TextArea =====

com.ergotech.vib.graphics.TextArea

==== Image Examples ====

| {{:mistudio:graphics:basic_layout:text_fields:pasted:20260622-154115.png?40|TextArea in the graphics palette}} | {{:mistudio:graphics:basic_layout:text_fields:pasted:20260622-153902.png?100|TextArea graphic example}} |
| //TextArea in the graphics palette.// | //TextArea graphic example.// |

==== Overview ====

The TextArea graphic is a Basic Layout text field graphic used to display or enter longer text values.

TextArea is useful when an application needs a larger text display area, multi-line text, notes, messages, instructions, or runtime text updates.

TextArea shares common properties with other Basic Layout text field graphics. See [[mistudio:design_editor:basic_layout:text_fields:text_field_common_properties|Text Field Common Properties]] for shared font, color, editable, enabled, background, visibility, and data source behavior.

==== Common Uses ====

  * Displaying longer text values
  * Showing multi-line messages
  * Entering or editing text
  * Displaying notes or instructions
  * Showing string values from a data source
  * Updating displayed text from logic

==== Input Behavior ====

The TextArea display can be updated from an input connection.

This can be useful when the TextArea needs to show a string value, message, or updated text from another source.

==== Output Behavior ====

TextArea can provide an output value through its **PrimaryOutPort**.

This allows the TextArea value to be used by other logic components when the graphic is configured to send or update values.

==== TextArea-Specific Behavior ====

TextArea supports longer text display and includes settings for how text is handled inside the field.

TextArea-specific settings may include:

  * **Maximum Characters** Sets the maximum number of characters allowed.
  * **Max Cache Size** Sets the maximum cache size used by the TextArea.
  * **Overlap** Sets the overlap value used by the TextArea.
  * **Wrap Text** Controls whether long lines wrap inside the TextArea.
  * **Resume When Connected** Controls whether the TextArea resumes behavior when connected, if supported by the current configuration.

==== Logic Ports ====

In the Logic Editor, TextArea may include ports such as:

  * **PrimaryOutPort**
  * **sendValueTrigger**
  * **updateDisplayedValue**
  * **clearDataConnection**

The exact available ports may depend on the current MIStudio version and configuration.

==== Notes ====

For shared text field settings, see [[mistudio:design_editor:basic_layout:text_fields:text_field_common_properties|Text Field Common Properties]].

For general graphic behavior, see [[mistudio:design_editor:active_graphic|Active Graphic]].

==== Related Pages ====

  * [[mistudio:design_editor:start|MIStudio Design Editor]]
  * [[mistudio:design_editor:basic_layout:start|Basic Layout]]
  * [[mistudio:design_editor:basic_layout:text_fields:start|Text Fields]]
  * [[mistudio:design_editor:basic_layout:text_fields:text_field_common_properties|Text Field Common Properties]]
  * [[mistudio:design_editor:basic_layout:text_fields:textfield|TextField]]
  * [[mistudio:design_editor:basic_layout:text_fields:doubletextfield|DoubleTextField]]
  * [[mistudio:design_editor:basic_layout:text_fields:integertextfield|IntegerTextField]]
  * [[mistudio:design_editor:active_graphic|Active Graphic]]