MixedRealityKeyboard Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.Experimental.UI

Assembly:: Microsoft.MixedReality.Toolkit.SDK.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Class that can launch and hide a system keyboard specifically for Windows Mixed Reality devices (HoloLens 2, Windows Mixed Reality).

Implements a workaround for UWP TouchScreenKeyboard bug which prevents UWP keyboard from showing up again after it is closed. Unity bug tracking the issue https://fogbugz.unity3d.com/default.asp?1137074_rttdnt8t1lccmtd3

public ref class MixedRealityKeyboard : Microsoft::MixedReality::Toolkit::Experimental::UI::MixedRealityKeyboardBase

[UnityEngine.AddComponentMenu("Scripts/MRTK/Experimental/Keyboard/MixedRealityKeyboard")]
public class MixedRealityKeyboard : Microsoft.MixedReality.Toolkit.Experimental.UI.MixedRealityKeyboardBase

[<UnityEngine.AddComponentMenu("Scripts/MRTK/Experimental/Keyboard/MixedRealityKeyboard")>]
type MixedRealityKeyboard = class
    inherit MixedRealityKeyboardBase

Public Class MixedRealityKeyboard
Inherits MixedRealityKeyboardBase

Inheritance: UnityEngine.MonoBehaviour

MixedRealityKeyboardBase
MixedRealityKeyboard

Attributes: UnityEngine.AddComponentMenuAttribute

Constructors

MixedRealityKeyboard()

Properties

CaretIndex	Returns the index of the caret within the text. (Inherited from MixedRealityKeyboardBase)
DisableUIInteractionWhenTyping	Whether disable user's interaction with other UI elements while typing. Use this option to decrease the chance of keyboard getting accidentally closed. (Inherited from MixedRealityKeyboardBase)
OnCommitText	Event which triggers when commit action is invoked on the keyboard. (Usually the return key.) (Inherited from MixedRealityKeyboardBase)
OnHideKeyboard	Event which triggers when the keyboard is hidden. (Inherited from MixedRealityKeyboardBase)
OnShowKeyboard	Event which triggers when the keyboard is shown. (Inherited from MixedRealityKeyboardBase)
Text	Returns the committed text.
Visible	Returns true if the keyboard is currently open. (Inherited from MixedRealityKeyboardBase)

Methods

ClearKeyboardText()	Removes the current text from the keyboard. (Inherited from MixedRealityKeyboardBase)
HideKeyboard()	Closes the keyboard for user interaction. (Inherited from MixedRealityKeyboardBase)
ShowKeyboard(String, Boolean)	Opens the keyboard for user interaction. (Inherited from MixedRealityKeyboardBase)
SyncCaret()	(Inherited from MixedRealityKeyboardBase)

Applies to