structure UI_EVENTPARAMS_COMMAND (uiribbon.h)

Contient des informations sur une commande associée à un événement.

Syntaxe

typedef struct _UI_EVENTPARAMS_COMMAND {
  UINT             CommandID;
  PCWSTR           CommandName;
  UINT             ParentCommandID;
  PCWSTR           ParentCommandName;
  UINT             SelectionIndex;
  UI_EVENTLOCATION Location;
} UI_EVENTPARAMS_COMMAND;

Membres

CommandID

ID de la commande directement liée à l’événement, qui est spécifié dans le fichier de ressources de balisage.

CommandName

Nom de la commande associé à CommandId.

ParentCommandID

ID du parent de la commande, qui est spécifié dans le fichier de ressources de balisage.

ParentCommandName

Nom de la commande du parent associé à CommandId.

SelectionIndex

SelectionIndex est utilisé uniquement lorsqu’un UI_EVENTTYPE_CommandExecuted a été déclenché en réponse à la sélection par l’utilisateur d’un élément dans une zone de liste déroulante ou une galerie d’éléments. Dans ce cas, SelectionIndex contient l’index de l’élément sélectionné. Dans tous les autres cas, il est défini sur 0.

Location

Une des valeurs de UI_EVENTLOCATION.

Remarques

La commande identifiée par CommandID et CommandName dépend de l’événement qui s’est produit : pour un événement UI_EVENTTYPE_TabActivated, ils identifient l’onglet ; pour un événement UI_EVENTTYPE_MenuOpened , ils identifient le menu ; pour les événements UI_EVENTTYPE_CommandExecuted , ils identifient la commande en cours d’exécution ; et pour les événements UI_EVENTTYPE_TooltipShown , ils identifient la commande qui possède cette info-bulle.

ParentCommandID et ParentCommandName identifient la commande parente (le cas échéant) de la commande associée à cet événement. S’il n’y a pas de parent, ParentCommandID a la valeur zéro et ParentCommandName est une chaîne vide.

Configuration requise

Voir aussi

OnUIEvent

Structures

UI_EVENTPARAMS