SystemUI.ShowVirtualKeyboardAsync Method

Displays a virtual keyboard.

Syntax

public:
static IAsyncOperation<String^ >^ ShowVirtualKeyboardAsync(
         String^ defaultText,
         String^ titleText,
         String^ descriptionText,
         VirtualKeyboardInputScope inputScope
)

Parameters

defaultText
Type: String

Default text.

titleText
Type: String

Title text.

descriptionText
Type: String

Description text.

inputScope
Type: VirtualKeyboardInputScope

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.

Return value

Type: IAsyncOperation<String^ >

Returns an IAsyncOperation<TResult> object that represents the state of the asynchronous operation. Completion of the asynchronous operation is signaled by using a handler that is passed to the IAsyncOperation<TResult>.Completed property. When the asynchronous operation is complete, the result of the operation can be retrieved by using the IAsyncOperation<TResult>.GetResults method.

The result of the asynchronous operation is a string containing the text the user entered.

Remarks

Calling this function when the app is not in focus will raise a Platform::Exception with an E_ACCESSDENIED HRESULT.

For more information about using a virtual keyboard, see Virtual Keyboard Overview.

Requirements

Namespace: Windows.Xbox.UI

Metadata: windows.winmd