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

Script language

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

InputField.multiLine

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

public var multiLine: bool;
public bool multiLine;

Description

If the input field supports multiple lines.

#pragma strict
// Required when Using UI elements.
public class Example {
    public var mainInputField;
    public function Update() {
        //Check to see if the input field is set to allow multiple lines.
        if (mainInputField.multiLine) {
            //Set the input field to only allow Single Lines, if it is currently set to allow Multiple lines.
            mainInputField.lineType = InputField.LineType.SingleLine;
            //Print to console
            Debug.Log("The main input field is now set to allow single lines only!");
        }
    }
}
using UnityEngine;
using System.Collections;
using UnityEngine.UI; // Required when Using UI elements.

public class Example : MonoBehaviour { public InputField mainInputField;

public void Update() { //Check to see if the input field is set to allow multiple lines. if (mainInputField.multiLine) { //Set the input field to only allow Single Lines, if it is currently set to allow Multiple lines. mainInputField.lineType = InputField.LineType.SingleLine; //Print to console Debug.Log("The main input field is now set to allow single lines only!"); } } }

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