---
title: "Text Area"
description: "Suitable for multi-line text display and editing. Will scroll vertically on demand. Will scroll horizontally if line wrap is off. Only supports plain-text, no HTML formatting or styled text."
---

# Text Area

> Suitable for multi-line text display and editing. Will scroll vertically on demand. Will scroll horizontally if line wrap is off. Only supports plain-text, no HTML formatting or styled text.

![](text-area.png)

**Component Palette Icon**

![](text-area1.png)

## Properties

 Some of the following properties are new.

|Name|Description|Property Type|Scripting|Category|
| -------------------------- | -------------------------- | ------- | ------------------------ | ---------- |
| Antialias | Draw with antialias on? Makes text smoother.  | boolean | .antialias   | Appearance |
| Background Color| The background color of the component.   | Color   | .background  | Appearance |
| Border| The border surrounding this component. NOTE that the border is unaffected by rotation.  | Border  | .border | Common     |
| Columns | The number of columns you expect to display (used as a hint for scrollbars).| int  | .columns | Appearance |
| Cursor | The mouse cursor to use when hovering over this component. | int     | .cursorCode | Common  |
| Data Quality   | The data quality code for any tag bindings on this component.| int| .dataQuality  | Data|
| Defer Updates  | When true, the 'text' property will not fire updates while typing. It will wait for the component to lose focus.| boolean | .deferUpdates| Behavior|
| Editable  | Controls whether or not the user can edit the text within this text area. | boolean | .editable | Behavior   |
| Enabled  | If disabled, a component cannot be used. | boolean | .componentEnabled | Common |
| Font | Font of text on this component. | Font | .font   | Appearance |
| Foreground Color| The foreground color of the component.  | Color   | .foreground   | Appearance |
| Line Wrap | Should this area wrap lines?  | boolean | .lineWrap  | Behavior |
| Mouseover Text | The text that is displayed in the tooltip which pops up on mouseover of this component. | String| .toolTipText| Common |
| Name| The name of this component. | String  | .name  | Common |
| Reject Updates During Edit | If true, this field will not accept updates from external sources (like DB bindings) while the user is editing the field. | boolean | .rejectUpdatesDuringEdit | Behavior   |
| Rows | The number of rows you expect to display (used as a hint for scrollbars). | int| .rows| Appearance |
| Styles  | Contains the component's styles.| Dataset | .styles | Appearance |
| Tab Size | This adjusts the default size of tab characters. | int | .tabSize  | Appearance |
| Text  | Text of this component.| String  | .text | Data  |
| Touchscreen Mode | Controls when this input component responds if touchscreen mode is enabled.  | int  | .touchscreenMode  | Behavior|
| Visible  | If disabled, the component will be hidden.  | boolean | .visible | Common     |

## Scripting

### Scripting Functions
This component does not have scripting functions associated with it.

### Extension Functions
This component does not have extension functions associated with it.

### Event Handlers
Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the [Component Events](scripting\scripting-in-ignition\component-and-window-scripting\component-events.md) page

## Customizers
+ [Vision Component Customizers](visualization-and-dashboards\understanding-components\component-customizers\component-customizers.md)
+ [Style Customizer](visualization-and-dashboards\understanding-components\component-customizers\component-customizers.md#style-customizer)

## Examples

### Word Wrap and No Scroll Bars until Needed

![](text-area-example.png)

|Property Name|Value|
|:---|:---|
|Line Wrap |True|
|Text |514 Characters|
|Rows|0|
|Columns|0|