Unity Script Reference – TouchScreenKeyboard

TouchScreenKeyboard

Interface into iPhone and Android native on screen keyboards. 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.

Apple's API does not allow to explicitly control the orientation of the keyboard. Instead you can define TouchScreenKeyboard.autorotateToPortrait, TouchScreenKeyboard.autorotateToPortraitUpsideDown, TouchScreenKeyboard.autorotateToLandscapeLeft, TouchScreenKeyboard.autorotateToLandscapeRight if the keyboard needs to be automatically rotated to match a specific orientation of the device.

Variables

text	Returns the text displayed by the input field of the keyboard. This
active	Specifies if the keyboard is visible or is sliding into the position on
done	Specifies if input process was finished (Read Only)

Class Variables

hideInput	Specifies if text input field above the keyboard will be hidden when
autorotateToPortrait	Specifies whether the keyboard should be automatically rotated to
autorotateToPortraitUpsideDown	Specifies whether the keyboard should be automatically rotated to
autorotateToLandscapeLeft	Specifies whether the keyboard should be automatically rotated to
autorotateToLandscapeRight	Specifies whether the keyboard should be automatically rotated to
area	Returns portion of the screen which is covered by the keyboard. Returns
visible	Returns true whenever any keyboard is completely visible on the screen.

Class Functions

Open	Opens the native keyboard provided by OS on the screen.