IInvokableCommand.Invoke(Object)-Methode

Definition

Namensraum: Microsoft.CommandPalette.Extensions

Die Methode, die aufgerufen wird, wenn ein Benutzer einen Befehl auswählt.

Die Parameter

sender-Objekt

Stellt den Kontext dar, von dem aus der Befehl aufgerufen wurde. Je nachdem, wo der Befehl verwendet wird, kann es sich um verschiedene Typen handeln:

• TopLevelCommands (und Fallbacks): sender ist das ICommandItem für den Befehl auf oberster Ebene, der aufgerufen wurde.
• IListPage.GetItems(): sender ist das IListItem für das Listenelement, das für diesen Befehl ausgewählt wurde.
• ICommandItem.MoreCommands (Kontextmenüs): Der Absender ist entweder das IListItem , an das der Befehl für eine Listenseite angehängt wurde, oder das ICommandItem des Befehls der obersten Ebene (wenn es sich um ein Kontextelement in einem Befehl der obersten Ebene handelt).
• IContentPage.Commands: sender ist die IContentPage selbst.

Die Verwendung des sender-Parameters kann für große Listen von Elementen nützlich sein, in denen die umsetzbaren Informationen für jedes Element in etwa identisch sind. Ein Beispiel wäre eine lange Liste von Links. Sie können dies als einzelnen IInvokableCommand implementieren, der eine URL basierend auf dem übergebenen Absenderobjekt öffnet. Anschließend speichert jedes Listenelement die zu öffnende URL und den Titel des Links. Dies führt zu einem geringeren Mehraufwand für die Kommunikation zwischen Erweiterung und Host.

Rückkehr

Ein ICommandResult-Objekt , das das Ergebnis des Befehlsaufrufs darstellt. Dieses Objekt kann Informationen über den Erfolg oder Misserfolg des Befehls sowie alle zusätzlichen Daten enthalten, die für die Ausführung des Befehls relevant sein können.

Beispiel

Unter Hinzufügen eines Befehls finden Sie ein Beispiel für die Implementierung dieser Methode.