Version: 2023.2
LanguageEnglish
  • C#
Method group is Obsolete

TouchScreenKeyboard.done

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

Obsolete Property done is deprecated, use status instead. public bool done;

Description

Specifies if input process was finished. (Read Only)

Keyboard input process can be finished either by user tapping "Done" button or script setting active property to false. Note that keyboard might be temporarily inactive (either by sliding in/out due to orientation change or by appearance of another keyboard), however its input process might still be not finished and will be resumed automatically.

using UnityEngine;

public class Example : MonoBehaviour { // Opens a keyboard and shows what has been typed.

TouchScreenKeyboard keyboard; public string text = "";

void Start() { keyboard = TouchScreenKeyboard.Open(text, TouchScreenKeyboardType.Default); }

void Update() { if (keyboard != null && keyboard.status == TouchScreenKeyboard.Status.Done) { text = keyboard.text; print("User input is: " + text); } } }