AppTaskContent.SetTextInput(String, String) Method
Definition
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.
Sets up a text input field for the user to provide a free-form text response.
public:
virtual void SetTextInput(Platform::String ^ placeholderText, Platform::String ^ actionUriTemplate) = SetTextInput;/// [Windows.Foundation.Metadata.Experimental]
void SetTextInput(winrt::hstring const& placeholderText, winrt::hstring const& actionUriTemplate);[Windows.Foundation.Metadata.Experimental]
public void SetTextInput(string placeholderText, string actionUriTemplate);function setTextInput(placeholderText, actionUriTemplate)Public Sub SetTextInput (placeholderText As String, actionUriTemplate As String)Parameters
- placeholderText
-
String
Platform::String
winrt::hstring
The placeholder text displayed in the input field to guide the user.
- actionUriTemplate
-
String
Platform::String
winrt::hstring
A URI template string containing {userTextInput} that will be replaced with the user's escaped input text when submitted.
- Attributes
Remarks
Important
App task support will start gradually rolling out to Windows 11 starting May, 2026. The experiences enabled by Windows.UI.Shell.Tasks APIs require that the corresponding app task feature be present in the version of Windows where the app runs. Otherwise, these APIs will not have any effect.
Use this method to collect text input from the user when the task needs attention. The {userTextInput} expression in the URI template is replaced with the URL-encoded user input. For example, if the template is my-app:task/?response={userTextInput} and the user enters "scope only", the resulting URI will be my-app:task/?response=scope%20only.