SystemUI.ShowVirtualKeyboardWithOptionsAsync Method

Displays a virtual keyboard with the specified options.

Syntax

public:
static IAsyncOperation<String^ >^ ShowVirtualKeyboardWithOptionsAsync(
         KeyboardOptions^ options
)

Parameters

options
Type: KeyboardOptions

Options specifying the behavior of the virtual keyboard.

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