COleCmdUI, classe

Implémente une méthode pour que MFC mette à jour l'état des objets d'interface utilisateur associés aux fonctionnalités pilotées par IOleCommandTargetde votre application.

Syntaxe

class COleCmdUI : public CCmdUI

Membres

Constructeurs publics

Méthodes publiques

Notes

Dans une application qui n’est pas activée pour DocObjects, lorsque l’utilisateur affiche un menu dans l’application, MFC traite UPDATE_COMMAND_UI notifications. Chaque notification reçoit un objet CCmdUI qui peut être manipulé pour refléter l’état d’une commande particulière. Toutefois, lorsque votre application est activée pour DocObjects, MFC traite UPDATE_OLE_COMMAND_UI notifications et affecte des COleCmdUI objets.

COleCmdUI permet à un DocObject de recevoir des commandes qui proviennent de l’interface utilisateur de son conteneur (par exemple, FileNew, Open, Print, etc.) et permet à un conteneur de recevoir des commandes provenant de l’interface utilisateur de DocObject. Bien qu’il IDispatch puisse être utilisé pour distribuer les mêmes commandes, IOleCommandTarget offre un moyen plus simple d’interroger et d’exécuter, car il s’appuie sur un ensemble standard de commandes, généralement sans arguments, et aucune information de type n’est impliquée. COleCmdUI peut être utilisé pour activer, mettre à jour et définir d’autres propriétés des commandes d’interface utilisateur DocObject. Lorsque vous souhaitez appeler la commande, appelez COleServerDoc ::OnExecOleCmd.

Pour plus d’informations sur DocObjects, consultez CDocObjectServer et CDocObjectServerItem.

Hiérarchie d'héritage

CCmdUI

COleCmdUI

Spécifications

En-tête : afxdocob.h

COleCmdUI ::COleCmdUI

Construit un COleCmdUI objet associé à une commande d’interface utilisateur particulière.

COleCmdUI(
    OLECMD* rgCmds,
    ULONG cCmds,
    const GUID* m_pGroup);

Paramètres

rgCmds
Liste des commandes prises en charge associées au GUID donné. La OLECMD structure associe des commandes à des indicateurs de commande.

cCmds
Nombre de commandes dans rgCmds.

pGroup
Pointeur vers un GUID qui identifie un ensemble de commandes.

Notes

L’objet COleCmdUI fournit une interface programmatique pour mettre à jour des objets d’interface utilisateur DocObject, tels que des éléments de menu ou des boutons de barre de contrôle. Les objets d’interface utilisateur peuvent être activés, désactivés, vérifiés et/ou effacés via l’objet COleCmdUI .

COleCmdUI ::Enable

Appelez cette fonction pour définir l’indicateur de commande de l’objet COleCmdUI sur OLECOMDF_ENABLED, ce qui indique à l’interface que la commande est disponible et activée, ou pour effacer l’indicateur de commande.

virtual void Enable(BOOL bOn);

Paramètres

bOn
Indique si la commande associée à l’objet COleCmdUI doit être activée ou désactivée. Non-zéro active la commande ; 0 désactive la commande.

COleCmdUI ::SetCheck

Appelez cette fonction pour définir l’état d’une commande bascule activée/désactivée.

virtual void SetCheck(int nCheck);

Paramètres

nCheck
Valeur déterminant l’état à définir une commande bascule activée/désactivée. Les valeurs sont les suivantes :

COleCmdUI ::SetText

Appelez cette fonction pour retourner un nom de texte ou une chaîne d’état pour une commande.

virtual void SetText(LPCTSTR lpszText);

Paramètres

lpszText
Pointeur vers le texte à utiliser avec la commande.

Voir aussi

CCmdUI, classe
Graphique hiérarchique