AppTaskContent 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
表示在 Windows Shell UI 中为应用任务显示的内容。 使用此类创建任务进度和结果的不同可视表示形式。
public ref class AppTaskContent sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.UI.Shell.Tasks.AppTaskContract, 65536)]
/// [Windows.Foundation.Metadata.Experimental]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AppTaskContent final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.UI.Shell.Tasks.AppTaskContract), 65536)]
[Windows.Foundation.Metadata.Experimental]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AppTaskContent
Public NotInheritable Class AppTaskContent
- 继承
- 属性
Windows 要求
| 要求 | 说明 |
|---|---|
| 设备系列 |
Windows Desktop Extension SDK (在 10.0.26100.0 中引入)
|
| API contract |
Windows.UI.Shell.Tasks.AppTaskContract (在 v2.0 中引入)
|
注解
重要
从 2026 年 5 月开始,应用任务支持将逐步推出到 Windows 11。 API 启用 Windows.UI.Shell.Tasks 的体验要求在运行应用的 Windows 版本中存在相应的应用任务功能。 否则,这些 API 将没有任何影响。
AppTaskContent 可以为不同的支持表示形式构造:
- 步骤序列:显示任务的分步进度。 使用 CreateSequenceOfSteps。
- 预览缩略图:显示任务输出的预览缩略图。 使用 CreatePreviewThumbnail。
- 文本摘要结果:显示带有简短文本说明的任务结果摘要。 使用 CreateTextSummaryResult。
- 生成的资产结果:显示包含生成的资产的任务结果的摘要。 使用 CreateGeneratedAssetsResult。
当任务需要用户注意时,可以使用 SetQuestion、 AddButton 或 SetTextInput 添加其他元素。
使用 shell 任务 API
需要打包使用这些 API 的应用。 有关详细信息,请参阅 打包概述 。
还需要将 com.microsoft.apptaskproviderAppExtension 添加到应用清单,如下所示:
<Package
xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
xmlns:uap3="http://schemas.microsoft.com/appx/manifest/uap/windows10/3"
IgnorableNamespaces="rescap uap uap3">
...
<Application>
...
<Extensions>
<uap3:Extension Category="windows.appExtension">
<uap3:AppExtension
Name="com.microsoft.apptaskprovider"
PublicFolder="Public"
Id="MyApp.AppTaskProvider"
DisplayName="AppTaskProvider for MyApp"/>
</uap3:Extension>
</Extensions>
...
</Application>
...
</Package>
属性
| 名称 | 说明 |
|---|---|
| MaxButtons |
获取可添加到任务内容的最大按钮数。 |
方法
| 名称 | 说明 |
|---|---|
| AddButton(String, Uri) |
将按钮添加到用户可以单击的任务内容以执行操作。 |
| CreateGeneratedAssetsResult(AppTaskResultAsset[]) |
创建显示任务生成的资产集合的任务内容。 |
| CreatePreviewThumbnail(Uri, String) |
创建显示任务输出预览缩略图的任务内容。 |
| CreateSequenceOfSteps(String[], String) |
创建显示任务进度的步骤序列的任务内容。 |
| CreateTextSummaryResult(String) |
创建显示任务结果的文本摘要的任务内容。 |
| SetQuestion(String) |
设置在任务需要注意时向用户显示的问题。 |
| SetTextInput(String, String) |
为用户设置文本输入字段以提供自由格式的文本响应。 |