Open(string, TouchScreenKeyboardType, bool, bool, bool, bool, string, int)

Opens the native keyboard provided by OS on the screen.

Read time 2 minutes

Last updated 2 months ago

Definition

Type: Method
Namespace: UnityEngine
Assembly: UnityEngine.CoreModule


public static TouchScreenKeyboard Open(string text, TouchScreenKeyboardType keyboardType, bool autocorrection, bool multiline, bool secure, bool alert, string textPlaceholder, int characterLimit)

Parameters

text

string

Text to edit.

keyboardType

TouchScreenKeyboardType

Type of keyboard (eg, any text, numbers only, etc).

autocorrection

bool

Is autocorrection applied?

multiline

bool

Can more than one line of text be entered?

secure

bool

Is the text masked (for passwords, etc)?

alert

bool

Is the keyboard opened in alert mode?

textPlaceholder

string

Text to be used if no other text is present.

characterLimit

int

How many characters the keyboard input field is limited to. 0 = infinite. (Android and iOS only)

Returns

Type	Description
TouchScreenKeyboard

Remarks

The

autocorrection

determines whether the input tracks unknown words and suggests a more suitable replacement candidate to the user, replacing the typed text automatically unless the user explicitly overrides the action. The

multiline

determines if user can input more than one line of text. The

secure

identifies whether the keyboard is used for password. Text in the input field will be hidden from the user except the recently typed character. The keyboard can be opened in the

alert

mode too. The

placeholder

string will be displayed when there is no other text in the input field of the keyboard.

Additional resources: Alert keyboard

Examples


using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{    public string stringToEdit = "Hello World";    private TouchScreenKeyboard keyboard;    // Opens native keyboard    void OnGUI()    {        stringToEdit = GUI.TextField(new Rect(10, 10, 200, 30), stringToEdit, 30);        if (GUI.Button(new Rect(10, 50, 200, 100), "Default"))        {            keyboard = TouchScreenKeyboard.Open("", TouchScreenKeyboardType.Default);        }        if (GUI.Button(new Rect(10, 150, 200, 100), "ASCIICapable"))        {            keyboard = TouchScreenKeyboard.Open("", TouchScreenKeyboardType.ASCIICapable);        }        if (GUI.Button(new Rect(10, 250, 200, 100), "Numbers and Punctuation"))        {            keyboard = TouchScreenKeyboard.Open("", TouchScreenKeyboardType.NumbersAndPunctuation);        }        if (GUI.Button(new Rect(10, 350, 200, 100), "URL"))        {            keyboard = TouchScreenKeyboard.Open("", TouchScreenKeyboardType.URL);        }        if (GUI.Button(new Rect(10, 450, 200, 100), "NumberPad"))        {            keyboard = TouchScreenKeyboard.Open("", TouchScreenKeyboardType.NumberPad);        }        if (GUI.Button(new Rect(10, 550, 200, 100), "PhonePad"))        {            keyboard = TouchScreenKeyboard.Open("", TouchScreenKeyboardType.PhonePad);        }        if (GUI.Button(new Rect(10, 650, 200, 100), "NamePhonePad"))        {            keyboard = TouchScreenKeyboard.Open("", TouchScreenKeyboardType.NamePhonePad);        }        if (GUI.Button(new Rect(10, 750, 200, 100), "EmailAddress"))        {            keyboard = TouchScreenKeyboard.Open("", TouchScreenKeyboardType.EmailAddress);        }        if (GUI.Button(new Rect(10, 850, 200, 100), "Social"))        {            keyboard = TouchScreenKeyboard.Open("", TouchScreenKeyboardType.Social);        }        if (GUI.Button(new Rect(10, 950, 200, 100), "Search"))        {            keyboard = TouchScreenKeyboard.Open("", TouchScreenKeyboardType.Search);        }        // Only supported on iOS        if (GUI.Button(new Rect(10, 1050, 200, 100), "One Time Code"))        {            keyboard = TouchScreenKeyboard.Open("", TouchScreenKeyboardType.OneTimeCode);        }    }}