JumpListItem 类

  • 参考

定义

命名空间:
Windows.UI.StartScreen
编辑

提供用于为应用的跳转列表创建和定义跳转列表项的功能。

public ref class JumpListItem sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class JumpListItem final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class JumpListItem
Public NotInheritable Class JumpListItem
继承
Object Platform::Object IInspectable JumpListItem
属性
ContractVersionAttribute MarshalingBehaviorAttribute

Windows 要求

设备系列
Windows 10 (在 10.0.10586.0 中引入)
API contract
Windows.Foundation.UniversalApiContract (在 v2.0 中引入)

示例

以下示例演示如何为 JumpList 创建一个任务，该任务使用命令行参数启动应用并执行所需操作。 不会显示本地化，但通过使用 ms-resource： 和 ms-appx： URI 方案，可以针对 DisplayName、说明和徽标进行本地化。

private Windows.UI.StartScreen.JumpListItem CreateJumpListItemTask()
{
    var taskItem = JumpListItem.CreateWithArguments(
                            "/Argument", "DisplayName");

    // Set the description. (Optional.)
    taskItem.Description = "Compose a new message to " + friendName;

    // Set the logo for this jump list item. Must be ms-appx: or ms-appdata:.
    taskItem.Logo = new Uri("ms-appdata:///local/downloads/taskImage.png");

    // If the GroupName is left blank, then the item goes into the Tasks group by default.

    return taskItem;
}

partial class App
{
    protected override void OnLaunched(LaunchActivatedEventArgs e)
    {
        if (e.Kind == ActivationKind.Launch && e.Arguments == "/Argument")
        {
            // Run code relevant to the task that was selected.
        }
    }
}

注解

JumpListItem 是使用 CreateWithArguments 和 CreateSeparator 方法创建的。 创建后，可以使用跳转列表的 Items 属性和 SaveAsync 方法将它们添加到应用的跳转列表。 请注意，在用户界面中，用户可以右键单击自定义组中的跳转列表项，然后选择“从此列表中删除”。 当此操作发生时，系统会将该项标记为用户删除，并从 UI 中禁止显示它。 应用下次加载跳转列表时，应检查项，以查看该项的 RemovedByUser 属性是否设置为 True。 如果 RemovedByUser 为 True，则应用应将其内部状态更新为与用户发起的更改同步。 应用负责确保删除的项在再次满足添加条件（例如，用户再次打开关联文档）之前不会将其添加回跳转列表。

当应用使用 SaveAsync 保存 JumpList 时，操作系统将按如下所示组织项。

  • 删除任何 RemovedByUser 等于 True 的项。
  • 具有相同 GroupName 属性的项放在一起，保留其相对顺序。
  • 组按组中第一项的原始位置排序，但系统管理的组始终位于顶部，任务组始终位于底部（如果存在）。 这意味着，当应用使用 LoadCurrentAsync 方法加载其 JumpList 时，将按其组织顺序检索这些项，这可能与最初保存时跳转列表中项的顺序不一致。

属性

Arguments

获取跳转列表项的命令行参数。
Description

获取或设置跳转列表项任务说明。
DisplayName

获取或设置跳转列表项显示名称。 创建跳转列表项时，还可以使用 CreateWithArguments 方法将显示名称指定为参数。
GroupName

获取或设置跳转列表项自定义组名称。 如果未指定名称，则默认情况下会将该项添加到“任务”组。
Kind

获取跳转列表项的 JumpListItemKind 。
Logo

获取或设置跳转列表项的徽标。
RemovedByUser

获取一个布尔值，指示用户是否从应用的跳转列表中删除了跳转列表项。

方法

CreateSeparator()

创建一个跳转列表项，该项目是应用的跳转列表中的自定义组的惰性分隔符。
CreateWithArguments(String, String)

为应用的跳转列表创建新的跳转列表项。

适用于

另请参阅