ICoreWindowKeyboardInput ICoreWindowKeyboardInput ICoreWindowKeyboardInput ICoreWindowKeyboardInput Interface

Definition

Note

IsKeyboardInputEnabled may be altered or unavailable for releases after Windows Phone 8.1 GDR2.

The interface that a Windows Runtime class must implement in order to handle keyboard input.

public : interface ICoreWindowKeyboardInputpublic interface ICoreWindowKeyboardInputPublic Interface ICoreWindowKeyboardInput// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Phone.PhoneInternalContract (introduced v1)

Properties

IsKeyboardInputEnabled IsKeyboardInputEnabled IsKeyboardInputEnabled IsKeyboardInputEnabled

Note

IsKeyboardInputEnabled may be altered or unavailable for releases after Windows Phone 8.1 GDR2.

** only:** Gets or sets whether the touch keyboard is displayed to the user for text input.

public : PlatForm::Boolean IsKeyboardInputEnabled { get; set; }public bool IsKeyboardInputEnabled { get; set; }Public ReadWrite Property IsKeyboardInputEnabled As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

True if touch keyboard is enabled. Otherwise, false.

Remarks

If all of the following conditions occur, the value of the IsKeyboardInputEnabled property might not be accurate:

    1. You use the default buffer. (For example, you do not provide your own KeyboardInputBuffer.)
    1. You programmatically open the touch keyboard by setting IsKeyboardInputEnabled to true.
    1. The user presses the back button, which closes the touch keyboard.
    1. You read IsKeyboardInputEnabled and expect the value to be false (since the touch keyboard was closed), but the value is true. There are multiple workarounds for this scenario:
  • Do not use the default buffer.

  • Do not use IsKeyboardInputEnabled.
  • Listen to the Hiding event and set IsKeyboardInputEnabled to false.
  • Use the OccludedRect property to see if the touch keyboard is open.

KeyboardInputBuffer KeyboardInputBuffer KeyboardInputBuffer KeyboardInputBuffer

Note

KeyboardInputBuffer may be altered or unavailable for releases after Windows Phone 8.1 GDR2.

** only:** Gets or sets the KeyboardInputBuffer object that is used to receive buffered text input.

public : KeyboardInputBuffer KeyboardInputBuffer { get; set; }public KeyboardInputBuffer KeyboardInputBuffer { get; set; }Public ReadWrite Property KeyboardInputBuffer As KeyboardInputBuffer// This API is not available in Javascript.
Value
KeyboardInputBuffer KeyboardInputBuffer KeyboardInputBuffer KeyboardInputBuffer

The object that receives buffered text input.