CJumpList, classe

Voici CJumpList la liste des raccourcis révélés lorsque vous cliquez avec le bouton droit sur une icône dans la barre des tâches.

Syntaxe

class CJumpList;

Membres

Constructeurs publics

Nom	Description
CJumpList ::CJumpList	Construit un objet CJumpList.
CJumpList ::~CJumpList	Détruit un objet CJumpList .

Nom	Description
CJumpList ::AbortList	Abandonne une transaction de génération de liste sans valider.
CJumpList ::AddDestination	Surcharge. Ajoute la destination à la liste.
CJumpList ::AddKnownCategory	Ajoute une catégorie connue à la liste.
CJumpList ::AddTask	Surcharge. Ajoute des éléments à la catégorie Tâches canoniques.
CJumpList ::AddTasks	Ajoute des éléments à la catégorie Tâches canoniques.
CJumpList ::AddTaskSeparator	Ajoute un séparateur entre les tâches.
CJumpList ::ClearAll	Supprime toutes les tâches et destinations qui ont été ajoutées à l’instance actuelle jusqu’à CJumpList présent.
CJumpList ::ClearAllDestinations	Supprime toutes les destinations qui ont été ajoutées à l’instance actuelle jusqu’à CJumpList présent.
CJumpList ::CommitList	Termine une transaction de génération de listes et valide la liste signalée dans le magasin associé (le Registre dans ce cas.)
CJumpList ::GetDestinationList	Récupère un pointeur d’interface vers la liste de destination.
CJumpList ::GetMaxSlots	Récupère le nombre maximal d’éléments, y compris les en-têtes de catégorie qui peuvent s’afficher dans le menu de destination de l’application appelante.
CJumpList ::GetRemovedItems	Retourne un tableau d’éléments qui représentent des destinations supprimées.
CJumpList ::InitializeList	Commence une transaction de génération de liste.
CJumpList ::SetAppID	Définit l’ID de modèle utilisateur de l’application pour la liste qui sera générée.

Hiérarchie d'héritage

CJumpList

Spécifications

En-tête : afxadv.h

CJumpList ::~CJumpList

Détruit un objet CJumpList .

~CJumpList();

CJumpList ::AbortList

Abandonne une transaction de génération de liste sans valider.

void AbortList();

Notes

L’appel de cette méthode a le même effet que la CJumpList destruction sans appeler CommitList.

CJumpList ::AddDestination

Ajoute la destination à la liste.

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,
    LPCTSTR strDestinationPath);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellItem* pShellItem);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellLink* pShellLink);

Paramètres

lpcszCategoryName
Spécifie un nom de catégorie. Si la catégorie spécifiée n’existe pas, elle est créée.

strDestinationPath
Spécifie un chemin d’accès au fichier de destination.

strCategoryName
Spécifie un nom de catégorie. Si la catégorie spécifiée n’existe pas, elle est créée.

pShellItem
Spécifie un élément shell représentant la destination ajoutée.

pShellLink
Spécifie un lien Shell représentant la destination ajoutée.

Valeur de retour

Notes

L’instance des CJumpList destinations ajoutées en interne s’accumule, puis les valide .CommitList

CJumpList ::AddKnownCategory

Ajoute une catégorie connue à la liste.

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

Paramètres

category
Spécifie un type de catégorie connu. Peut être KDC_RECENT ou KDC_KNOWN.

Valeur de retour

Notes

Les catégories connues sont les catégories fréquentes et récentes que nous calculerons automatiquement pour chaque application qui utilise (ou indirectement l’utilise, car l’interpréteur de commandes SHAddToRecentDocs l’appellera au nom de l’application dans certains scénarios).

CJumpList ::AddTask

Ajoute des éléments à la catégorie Tâches canoniques.

BOOL AddTask(
    LPCTSTR strTargetExecutablePath,
    LPCTSTR strCommandLineArgs,
    LPCTSTR strTitle,
    LPCTSTR strIconLocation,
    int iIconIndex);

BOOL AddTask(IShellLink* pShellLink);

Paramètres

strTargetExecutablePath
Spécifie le chemin de la tâche cible.

strCommandLineArgs
Spécifie les arguments de ligne de commande de l’exécutable spécifié par strTargetExecutablePath.

strTitle
Nom de la tâche qui s’affiche dans la liste de destination.

strIconLocation
Emplacement de l’icône qui s’affiche dans la liste de destination, ainsi que le titre.

iIconIndex
Index d’icône.

pShellLink
Lien shell qui représente une tâche à ajouter.

Valeur de retour

Notes

L’instance d’accumulations CJumpList de tâches spécifiées et les ajoute à la liste de destination pendant CommitList. Les éléments de tâche apparaissent dans une catégorie en bas du menu de destination de l’application. Cette catégorie est prioritaire sur toutes les autres catégories lorsqu’elle est renseignée dans l’interface utilisateur.

CJumpList ::AddTasks

Ajoute des éléments à la catégorie Tâches canoniques.

BOOL AddTasks(IObjectArray* pObjectCollection);

Paramètres

pObjectCollection
Collection de tâches à ajouter.

Valeur de retour

Notes

L’instance de CJumpList accumule les tâches spécifiées et les ajoute à la liste de destination pendant CommitList. Les éléments de tâche apparaissent dans une catégorie en bas du menu de destination de l’application. Cette catégorie est prioritaire sur toutes les autres catégories lorsqu’elle est renseignée dans l’interface utilisateur.

CJumpList ::AddTaskSeparator

Ajoute un séparateur entre les tâches.

BOOL AddTaskSeparator();

Valeur de retour

Différent de zéro s’il réussit, 0 si ce n’est pas le cas.

CJumpList ::CJumpList

Construit un objet CJumpList.

CJumpList(BOOL bAutoCommit = TRUE);

Paramètres

bAutoCommit
Si ce paramètre a la valeur FALSE, la liste n’est pas validée automatiquement dans le destructeur.

CJumpList ::ClearAll

Supprime toutes les tâches et destinations qui ont été ajoutées à l’instance actuelle jusqu’à CJumpList présent.

void ClearAll();

Notes

Cette méthode efface et libère toutes les données et toutes les interfaces internes.

CJumpList ::ClearAllDestinations

Supprime toutes les destinations qui ont été ajoutées à l’instance actuelle de CJumpList jusqu’à présent.

void ClearAllDestinations();

Notes

Appelez cette fonction si vous devez supprimer toutes les destinations qui ont été ajoutées jusqu’à présent dans la session actuelle de génération de liste de destination et ajouter d’autres destinations. Si l’interne ICustomDestinationList a été initialisé, il reste vivant.

CJumpList ::CommitList

Termine une transaction de génération de listes et valide la liste signalée dans le magasin associé (le Registre dans ce cas).

BOOL CommitList();

Valeur de retour

Notes

La validation est atomique. Une erreur est retournée si la validation échoue. Quand CommitList elle est appelée, la liste actuelle des éléments supprimés est nettoyée. L’appel de cette méthode réinitialise l’objet afin qu’il n’ait pas de transaction active de génération de listes. Pour mettre à jour la liste, BeginList doit être appelée à nouveau.

CJumpList ::GetDestinationList

Récupère un pointeur d’interface vers la liste de destination.

ICustomDestinationList* GetDestinationList();

Valeur de retour

Notes

Si la liste de raccourcis n’a pas été initialisée ou a été validée ou abandonnée, la valeur retournée est NULL.

CJumpList ::GetMaxSlots

Récupère le nombre maximal d’éléments, y compris les en-têtes de catégorie qui peuvent s’afficher dans le menu de destination de l’application appelante.

UINT GetMaxSlots() const;

Valeur de retour

Notes

Les applications peuvent uniquement signaler un certain nombre d’éléments et d’en-têtes de catégorie combinés jusqu’à cette valeur. Si les appels à AppendCategory, AppendKnownCategoryou AddUserTasks dépassent ce nombre, ils retournent un échec.

CJumpList ::GetRemovedItems

Retourne un tableau d’éléments qui représentent des destinations supprimées.

IObjectArray* GetRemovedItems();

Valeur de retour

Notes

Les destinations supprimées sont récupérées lors de l’initialisation de la liste de raccourcis. Lors de la génération d’une nouvelle liste de destination, les applications doivent d’abord traiter la liste des destinations supprimées, en désactivant leurs données de suivi pour tout élément retourné par l’énumérateur de liste supprimé. Si une application tente de fournir un élément qui vient d’être supprimé dans la transaction à laquelle l’appel actuel a BeginList démarré, l’appel de méthode qui a re-ajouté cet élément échoue pour s’assurer que les applications respectent la liste supprimée.

CJumpList ::InitializeList

Commence une transaction de génération de liste.

BOOL InitializeList();

Valeur de retour

Notes

Vous n’avez pas besoin d’appeler cette méthode explicitement, sauf si vous souhaitez récupérer un pointeur vers ICustomDestinationList l’utilisation GetDestinationList, le nombre d’emplacements disponibles à l’aide GetMaxSlotsou la liste d’éléments supprimés à l’aide GetRemovedItems.

CJumpList ::SetAppID

Définit l’ID de modèle utilisateur de l’application pour la liste qui sera générée.

void SetAppID(LPCTSTR strAppID);

Paramètres

strAppID
Chaîne qui spécifie l’ID de modèle utilisateur de l’application.

Voir aussi

Classes