Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

TextAreaAttribute

class in UnityEngine

/

Inherits from:PropertyAttribute

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Attribute to make a string be edited with a height-flexible and scrollable text area.

You can specify the minimum and maximum lines for the TextArea, and the field will expand according to the size of the text. A scrollbar will appear if the text is bigger than the area available.


Text Area in Inspector.

#pragma strict
public class TextAreaExample extends MonoBehaviour {
	@TextArea
	public var MyTextArea: String;
}
using UnityEngine;

public class TextAreaExample : MonoBehaviour { [TextArea] public string MyTextArea; }

Properties

maxLinesThe maximum amount of lines the text area can show before it starts using a scrollbar.
minLinesThe minimum amount of lines the text area will use.

Constructors

TextAreaAttributeAttribute to make a string be edited with a height-flexible and scrollable text area.

Inherited Members

Properties

orderOptional field to specify the order that multiple DecorationDrawers should be drawn in.

Did you find this page useful? Please give it a rating: