IUIFramework ::InvalidateUICommand, méthode (uiribbon.h)

  • Article

Invalide la propriété, la valeur ou l’état d’une infrastructure de ruban Windows.

Syntaxe

HRESULT InvalidateUICommand(
  [in] UINT32            commandId,
  [in] UI_INVALIDATIONS  flags,
  [in] const PROPERTYKEY *key
);

Paramètres

[in] commandId

Type : UINT32

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

[in] flags

Type : UI_INVALIDATIONS

Identifie l’aspect d’une commande à invalider.

Note Le passage UI_INVALIDATIONS_ALLPROPERTIES invalide toutes les propriétés liées à une commande, y compris la valeur et l’état.
 

[in] key

Type : const PROPERTYKEY*

Clé de propriété de la propriété ou de l’état de commande. Ce paramètre peut être NULL.

Valeur retournée

Type : HRESULT

Retourne S_OK en cas de réussite ; sinon, une valeur d’erreur de la liste suivante.

Valeur Description
E_INVALIDARG Une valeur non valide pour la clé a été fournie.
E_FAIL L'opération a échoué. Toutes les commandes n’ont pas pu être invalidées, ou aucune des propriétés spécifiées n’est prise en charge.

Remarques

Les ressources définies dans le balisage de l’infrastructure du ruban sont stockées dans une table de ressources créée lorsque le fichier de balisage est compilé au format binaire. Une ressource ne peut pas être rétablie à partir de la table de ressources Markup une fois qu’elle a été invalidée.

Après l’invalidation, l’infrastructure interroge l’application hôte pour obtenir les détails de la ressource.

Lorsqu’une valeur command est invalidée (indicateurs contient UI_INVALIDATIONS_VALUE), la valeur de la clé est NULL.

Si IUIFramework ::InvalidateUICommand est appelé plusieurs fois et que la valeur UI_INVALIDATIONS passée dans chaque appel spécifie des propriétés qui se chevauchent, telles que UI_INVALIDATIONS_STATE et UI_INVALIDATIONS_ALLPROPERTIES, un seul rappel à l’application hôte est créé.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible Windows
En-tête uiribbon.h
DLL Mshtml.dll

Voir aussi

IUIFramework

UI_INVALIDATIONS

Exemples d’infrastructure du ruban Windows