JumpListItem Classe

Définition

Espace de noms:

Windows.UI.StartScreen

Fournit des fonctionnalités permettant de créer et de définir des éléments de liste de raccourcis pour la liste de raccourcis d’une application.

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

Héritage

Object Platform::Object IInspectable JumpListItem

Attributs

ContractVersionAttribute MarshalingBehaviorAttribute

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10586.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v2.0)

Exemples

L’exemple suivant montre comment créer une tâche pour un JumpList qui lance l’application avec des paramètres de ligne de commande et effectue l’action souhaitée. La localisation n’est pas affichée, mais elle est possible pour le DisplayName, la description et le logo via l’utilisation des schémas d’URI ms-resource: et ms-appx: .

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.
        }
    }
}

Remarques

Un Objet JumpListItem est créé à l’aide des méthodes CreateWithArguments et CreateSeparator . Après leur création, ils peuvent être ajoutés à la liste de raccourcis de l’application à l’aide de la propriété Items de la liste de raccourcis et de la méthode SaveAsync . N’oubliez pas que dans l’interface utilisateur, un utilisateur peut cliquer avec le bouton droit sur un élément de liste de raccourcis qui se trouve dans un groupe personnalisé et sélectionner « Supprimer de cette liste ». Lorsque cette action se produit, le système marque l’élément comme supprimé par l’utilisateur et le supprime de l’interface utilisateur. La prochaine fois qu’une application charge la liste de raccourcis, elle doit case activée les éléments pour voir si la propriété RemovedByUser de l’élément a la valeur True. Si RemovedByUser a la valeur True, l’application doit mettre à jour son état interne pour qu’elle soit synchronisée avec la modification initiée par l’utilisateur. Il incombe aux applications de s’assurer qu’un élément supprimé n’est pas ajouté à la liste de raccourcis jusqu’à ce que les conditions de son ajout soient à nouveau remplies, par exemple, par l’utilisateur qui ouvre à nouveau le document associé.

Lorsqu’une application enregistre la liste jumplist à l’aide de SaveAsync, le système d’exploitation organise les éléments comme suit.

• Tous les éléments dont RemovedByUser est égal à True sont supprimés.
• Les éléments ayant la même propriété GroupName sont placés ensemble, ce qui préserve leur ordre relatif.
• Les groupes sont classés en fonction de la position d’origine du premier élément du groupe, à l’exception du fait que les groupes gérés par le système sont toujours en haut et que le groupe Tâches se trouve toujours en bas s’ils sont présents. Cela signifie que lorsqu’une application charge sa JumpList à l’aide de la méthode LoadCurrentAsync , les éléments sont récupérés dans leur ordre organisé, ce qui peut ne pas convenir à l’ordre des éléments de la liste de raccourcis lors de son enregistrement initial.

Propriétés

Arguments	Obtient les arguments de ligne de commande pour l’élément de liste de raccourcis.
Description	Obtient ou définit la description de la tâche d’élément de liste de raccourcis.
DisplayName	Obtient ou définit le nom complet de l’élément de liste de raccourcis. Le nom d’affichage peut également être spécifié en tant que paramètre à l’aide de la méthode CreateWithArguments lors de la création de l’élément de liste de raccourcis.
GroupName	Obtient ou définit le nom de groupe personnalisé de l’élément de liste de raccourcis. Si aucun nom n’est spécifié, l’élément est ajouté au groupe Tâches par défaut.
Kind	Obtient le JumpListItemKind d’un élément de liste de raccourcis.
Logo	Obtient ou définit le logo de l’élément de liste de raccourcis.
RemovedByUser	Obtient une valeur booléenne indiquant si l’élément de liste de raccourcis a été supprimé de la liste de raccourcis de l’application par l’utilisateur.

Méthodes

CreateSeparator()	Crée un élément de liste de raccourcis qui est un séparateur inerte pour un groupe personnalisé dans la liste de raccourcis de l’application.
CreateWithArguments(String, String)	Crée un élément de liste de raccourcis pour la liste de raccourcis d’une application.

Voir aussi

• Exemple de personnalisation de liste de raccourcis