Méthode IInvokableCommand.Invoke(Object)

Définition

Espace de noms : Microsoft.CommandPalette.Extensions

Méthode appelée lorsqu’un utilisateur sélectionne une commande.

Paramètres

Objet expéditeur

Représente le contexte à partir duquel la commande a été appelée. Il peut s’agir de différents types selon l’endroit où la commande est utilisée :

• TopLevelCommands (et fallbacks) : sender est l’ICommandItem de la commande de niveau supérieur qui a été appelée.
• IListPage.GetItems() : l’expéditeur est l’IListItem de l’élément de liste sélectionné pour cette commande.
• ICommandItem.MoreCommands (menus contextuels) : l’expéditeur est soit l’IListItem auquel la commande a été attachée pour une page de liste, soit l’ICommandItem de la commande de niveau supérieur (s’il s’agit d’un élément de contexte sur une commande de niveau supérieur).
• IContentPage.Commands : l’expéditeur est l’IContentPage lui-même.

L’utilisation du paramètre sender peut être utile pour les grandes listes d’éléments où les informations exploitables pour chaque élément sont à peu près les mêmes. Un exemple serait une longue liste de liens. Vous pouvez implémenter cela sous la forme d’une seule IInvokableCommand qui ouvre une URL basée sur l’objet expéditeur transmis. Ensuite, chaque élément de la liste stocke l’URL à ouvrir et le titre du lien. Cela réduit la surcharge de communication entre l’extension et l’hôte.

Retours

Objet ICommandResult qui représente le résultat de l’appel de la commande. Cet objet peut contenir des informations sur la réussite ou l’échec de la commande, ainsi que toute donnée supplémentaire susceptible d’être pertinente pour l’exécution de la commande.

Exemple :

Voir Ajouter une commande pour un exemple d’implémentation de cette méthode.