VirtualKeyboardInputScope Enumeration

Specifies the required keys on the default page. It does not restrict the visibility or input to those keys. For example, “Number” and “TelephoneNumber” do not restrict the keyboard to numbers. They only ensure that the required number keys are available on the default keyboard page.

Syntax

public enum class VirtualKeyboardInputScope  

Members

Member Value Description
Alphanumeric 40   
Default   The default keyboard.
EmailSmtpAddress   Email address keyboard. Includes the @ and .com keys.
Number   The number keyboard. Contains numbers and a decimal point.
Password   The password keyboard. Contains the text input pattern for a password.
Search   The search keyboard. Includes auto-complete.
TelephoneNumber   The telephone keyboard. Mimics the telephone keypad.
Url   The Url keyboard. Includes the .com key.

Remarks

Use this enumeration in the SystemUI.ShowVirtualKeyboardAsync Method and SystemUI.ShowVirtualKeyboardWithOptionsAsync Method. For example code, see Virtual Keyboard Overview.

NOTE: An actual numeric scope virtual keyboard that contains only numbers is available beginning with the October 2018 preview release. When SystemUI::ShowVirtualKeyboardAsync and SystemUI::ShowVirtualKeyboardWithOptionsAsync are called with either VirtualKeyboardInputScope::Number or VirtualKeyboardInputScope::TelephoneNumber, we will now show this keyboard as opposed to the alphanumeric keyboard that appeared in earlier releases. For backward compatibility, we ensure that ERA callers will get the old behavior with these scopes, now and in the future; these scopes will be converted to VirtualKeyboardInputScope::Alphanumeric. Non-ERA titles using the numeric scopes will correctly get a numeric keyboard.

Requirements

Namespace: Windows.Xbox.UI

Metadata: windows.winmd

See also

Reference

Windows.Xbox.UI Namespace