class in UnityEngine
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseInterface 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.
area | Returns portion of the screen which is covered by the keyboard. |
hideInput | Will text input field above the keyboard be hidden when the keyboard is on screen? |
inputFieldAppearance | Returns the current visibility status of the on-screen keyboard's input field. (Read Only) |
isInPlaceEditingAllowed | Checks if the text within an input field can be selected and modified while TouchScreenKeyboard is open. |
isSupported | Is touch screen keyboard supported. |
visible | Returns true whenever any keyboard is visible on the screen. |
active | Is the keyboard visible or sliding into the position on the screen? |
canGetSelection | Specifies whether the TouchScreenKeyboard supports the selection property. (Read Only) |
canSetSelection | Specifies whether the TouchScreenKeyboard supports the selection property. (Read Only) |
characterLimit | How many characters the keyboard input field is limited to. 0 = infinite. |
selection | Gets or sets the character range of the selected text within the string currently being edited. |
status | Returns the status of the on-screen keyboard. (Read Only) |
targetDisplay | Specified on which display the on-screen keyboard will appear. |
text | Returns the text displayed by the input field of the keyboard. |
type | Returns the TouchScreenKeyboardType of the keyboard. |
Open | Opens the native keyboard provided by OS on the screen. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.