Version: 2020.1
LanguageEnglish
  • C#

TouchScreenKeyboard

class in UnityEngine

/

Implemented in:UnityEngine.CoreModule

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 for on-screen keyboards. Only native iPhone, Android, and Windows Store Apps are supported.

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.

Universal Windows Platform: On Universal Windows Apps the touch screen keyboard is supported when physical keyboard is not connected.

Static Properties

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?
isInPlaceEditingAllowedChecks if the text within an input field can be selected and modified while TouchScreenKeyboard is open.
isSupportedIs touch screen keyboard supported.
visibleReturns true whenever any keyboard is visible on the screen.

Properties

activeIs the keyboard visible or sliding into the position on the screen?
canGetSelectionSpecifies whether the TouchScreenKeyboard supports the selection property. (Read Only)
canSetSelectionSpecifies whether the TouchScreenKeyboard supports the selection property. (Read Only)
characterLimitHow many characters the keyboard input field is limited to. 0 = infinite.
selectionGets or sets the character range of the selected text within the string currently being edited.
statusReturns the status of the on-screen keyboard. (Read Only)
targetDisplaySpecified on which display the on-screen keyboard will appear.
textReturns the text displayed by the input field of the keyboard.
typeReturns the TouchScreenKeyboardType of the keyboard.

Static Methods

OpenOpens the native keyboard provided by OS on the screen.

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