===== Text Field Common Properties =====

This page documents common properties shared by Basic Layout text field graphics in MIStudio.

Text field graphics include:

  * [[mistudio:design_editor:basic_layout:text_fields:textarea|TextArea]]
  * [[mistudio:design_editor:basic_layout:text_fields:doubletextfield|DoubleTextField]]
  * [[mistudio:design_editor:basic_layout:text_fields:textfield|TextField]]
  * [[mistudio:design_editor:basic_layout:text_fields:integertextfield|IntegerTextField]]

==== Overview ====

Text field graphics are used to display or enter text and numeric values in an MIStudio application.

Some text field graphics are designed for general text, while others are designed for numeric input such as decimal or integer values.

Not every text field supports every property listed on this page. Check the individual graphic page for properties specific to that graphic.

==== Common Basic Properties ====

**Name** Sets the name of the text field graphic.

**Enabled** Controls whether the user can interact with the text field.

**Editable** Controls whether the user can edit the value in the text field, if supported.

**Font** Controls the font used for the displayed text.

**Text Color** Sets the color used for the displayed text.

**Formatter** Controls how the displayed value is formatted, if supported.

==== Text Selection and Cursor Properties ====

**Cursor Color** Sets the cursor color inside the text field, if supported.

**Selected Text Color** Sets the color of selected text.

**Selection Color** Sets the background color used for selected text.

**Horizontal Alignment** Controls how text is aligned inside the field, such as left, centered, or right.

==== Numeric Text Field Properties ====

Numeric text fields may include additional properties for value limits and numeric formatting.

**Minimum Value** Sets the lowest value allowed by the text field.

**Maximum Value** Sets the highest value allowed by the text field.

**Decimal Places** Sets how many decimal places are used by a decimal-style text field.

DoubleTextField commonly includes decimal places, minimum value, and maximum value settings.

IntegerTextField commonly includes minimum value and maximum value settings.

==== TextArea-Specific Properties ====

TextArea supports additional properties for longer or multi-line text display.

**Maximum Characters** Sets the maximum number of characters allowed in the TextArea.

**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.

==== Common Expert Properties ====

**Background Color** Sets the background color of the text field.

**Visible** Controls whether the text field is shown.

**Ignore Focus Lost** Controls whether the text field ignores focus lost behavior, if supported.

**Click Action** Defines a click action for the text field, if supported.

**Additional CSS Class** Adds an additional CSS class, if supported by the selected text field.

==== Logic Behavior ====

Text field graphics can appear in the Logic Editor as blocks with ports.

Depending on the graphic, text fields may support:

  * **PrimaryOutPort** for sending values
  * **updateDisplayedValue** for updating the displayed value from another source
  * Additional ports for specific text field behavior

The exact ports depend on the selected text field graphic.

==== Data Source Behavior ====

Text fields can be connected to data sources to update their displayed value.

TextField and TextArea are commonly used with string values.

DoubleTextField and IntegerTextField are commonly used with numeric values.

==== Notes ====

The available properties depend on the selected text field graphic and the current MIStudio version.

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:textarea|TextArea]]
  * [[mistudio:design_editor:basic_layout:text_fields:doubletextfield|DoubleTextField]]
  * [[mistudio:design_editor:basic_layout:text_fields:textfield|TextField]]
  * [[mistudio:design_editor:basic_layout:text_fields:integertextfield|IntegerTextField]]
  * [[mistudio:design_editor:active_graphic|Active Graphic]]
  * [[mistudio:getting_started:connect_data_source_to_graphic|Connecting a Data Source to a Graphic]]