UI_KeyboardInputField 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.

A component that can be added to InputField to make it work with Windows Mixed Reality's system keyboard. Only used in Unity 2018.4. No longer used in Unity 2019.3 and later versions (becomes an empty MonoBehaviour and is only around for compatibility) and you can safely remove it if you wish

public ref class UI_KeyboardInputField : Microsoft::MixedReality::Toolkit::Experimental::UI::KeyboardInputFieldBase<UnityEngine::UI::InputField ^>

public ref class UI_KeyboardInputField : Microsoft::MixedReality::Toolkit::Experimental::UI::KeyboardInputFieldBase<Microsoft::MixedReality::Toolkit::Experimental::UI::MRTKUGUIInputField ^>

public ref class UI_KeyboardInputField : UnityEngine::MonoBehaviour

[UnityEngine.AddComponentMenu("Scripts/MRTK/Experimental/Keyboard/UI_KeyboardInputField")]
[UnityEngine.RequireComponent(typeof(UnityEngine.UI.InputField))]
public class UI_KeyboardInputField : Microsoft.MixedReality.Toolkit.Experimental.UI.KeyboardInputFieldBase<UnityEngine.UI.InputField>

[UnityEngine.AddComponentMenu("Scripts/MRTK/Experimental/Keyboard/UI_KeyboardInputField")]
[UnityEngine.RequireComponent(typeof(Microsoft.MixedReality.Toolkit.Experimental.UI.MRTKUGUIInputField))]
public class UI_KeyboardInputField : Microsoft.MixedReality.Toolkit.Experimental.UI.KeyboardInputFieldBase<Microsoft.MixedReality.Toolkit.Experimental.UI.MRTKUGUIInputField>

[UnityEngine.AddComponentMenu("Scripts/MRTK/Experimental/Keyboard/UI_KeyboardInputField")]
[UnityEngine.RequireComponent(typeof(Microsoft.MixedReality.Toolkit.Experimental.UI.MRTKUGUIInputField))]
public class UI_KeyboardInputField : UnityEngine.MonoBehaviour

[<UnityEngine.AddComponentMenu("Scripts/MRTK/Experimental/Keyboard/UI_KeyboardInputField")>]
[<UnityEngine.RequireComponent(typeof(UnityEngine.UI.InputField))>]
type UI_KeyboardInputField = class
    inherit KeyboardInputFieldBase<InputField>

[<UnityEngine.AddComponentMenu("Scripts/MRTK/Experimental/Keyboard/UI_KeyboardInputField")>]
[<UnityEngine.RequireComponent(typeof(Microsoft.MixedReality.Toolkit.Experimental.UI.MRTKUGUIInputField))>]
type UI_KeyboardInputField = class
    inherit KeyboardInputFieldBase<MRTKUGUIInputField>

[<UnityEngine.AddComponentMenu("Scripts/MRTK/Experimental/Keyboard/UI_KeyboardInputField")>]
[<UnityEngine.RequireComponent(typeof(Microsoft.MixedReality.Toolkit.Experimental.UI.MRTKUGUIInputField))>]
type UI_KeyboardInputField = class
    inherit MonoBehaviour

Public Class UI_KeyboardInputField
Inherits KeyboardInputFieldBase(Of InputField)

Public Class UI_KeyboardInputField
Inherits KeyboardInputFieldBase(Of MRTKUGUIInputField)

Public Class UI_KeyboardInputField
Inherits MonoBehaviour

Inheritance: UnityEngine.MonoBehaviour

MixedRealityKeyboardBase

KeyboardInputFieldBase<UnityEngine.UI.InputField>
UI_KeyboardInputField

Inheritance: KeyboardInputFieldBase<MRTKUGUIInputField>
UI_KeyboardInputField

Inheritance: UnityEngine.MonoBehaviour
UI_KeyboardInputField

Attributes: UnityEngine.AddComponentMenuAttribute UnityEngine.RequireComponentAttribute

Remarks

If using Unity 2019 or 2020, make sure the version >= 2019.4.25 or 2020.3.2 to ensure the latest fixes for Unity keyboard bugs are present.

Constructors

UI_KeyboardInputField()

Fields

inputField

(Inherited from KeyboardInputFieldBase<T>)

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
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)
PlaceHolderGraphic(InputField)
PlaceHolderGraphic(MRTKUGUIInputField)
PlaceHolderGraphic(T)	(Inherited from KeyboardInputFieldBase<T>)
ShowKeyboard(String, Boolean)	Opens the keyboard for user interaction. (Inherited from MixedRealityKeyboardBase)
SyncCaret()
SyncCaret()	(Inherited from MixedRealityKeyboardBase)
TextGraphic(InputField)
TextGraphic(MRTKUGUIInputField)
TextGraphic(T)	(Inherited from KeyboardInputFieldBase<T>)

Applies to