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

Script language

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

TouchScreenKeyboard

class in UnityEngine

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

Interface into the native iPhone, Android, Windows Phone and Windows Store Apps on-screen keyboards - it is not available on other platforms.

This interface allows to display different types of the keyboard: ASCII, Numbers, URL, Email, and others.

Because the appearance of the keyboard has the potential to obscure portions of your user interface, it is up to you to make sure that parts of your user interface are not obscured when the keyboard is being displayed.

TouchScreenKeyboard.visible and TouchScreenKeyboard.area should be used to determine if the keyboard is being shown (activated) and what portion of the screen is using.

Windows Store Apps: On Universal Windows 10 Apps the touch screen keyboard is only supported in XAML based applications with touch input support.

Static Variables

areaReturns portion of the screen which is covered by the keyboard.
hideInputWill text input field above the keyboard be hidden when the keyboard is on screen?
isSupportedIs touch screen keyboard supported.
visibleReturns true whenever any keyboard is completely visible on the screen.

Variables

activeIs the keyboard visible or sliding into the position on the screen?
canGetSelectionSpecifies whether the TouchScreenKeyboard supports the selection property. (Read Only)
doneSpecifies if input process was finished. (Read Only)
selectionReturns the character range of the selected text within the string currently being edited. (Read Only)
targetDisplaySpecified on which display the software keyboard will appear.
textReturns the text displayed by the input field of the keyboard.
typeReturns the TouchScreenKeyboardType of the keyboard.
wasCanceledSpecifies if input process was canceled. (Read Only)

Static Functions

OpenOpens the native keyboard provided by OS on the screen.