IUICommandHandler ::UpdateProperty, méthode (uiribbon.h)

  • Article

Répond aux demandes de mise à jour de propriétés à partir de l’infrastructure du ruban Windows.

Syntaxe

HRESULT UpdateProperty(
  [in]           UINT32            commandId,
  [in]           REFPROPERTYKEY    key,
  [in, optional] const PROPVARIANT *currentValue,
  [out]          PROPVARIANT       *newValue
);

Paramètres

[in] commandId

Type : UINT32

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

[in] key

Type : REFPROPERTYKEY

Clé de propriété à mettre à jour.

[in, optional] currentValue

Type : const PROPVARIANT*

Pointeur vers la valeur actuelle de la clé. Ce paramètre peut être NULL.

[out] newValue

Type : PROPVARIANT*

Lorsque cette méthode est retournée, contient un pointeur vers la nouvelle valeur de clé.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Cette méthode doit être autorisée à retourner avant tout appel ultérieur à l’infrastructure du ruban.

Les valeurs des propriétés command, telles que UI_PKEY_Enabled ou UI_PKEY_Label, sont définies par le biais d’appels à SetUICommandProperty ou InvalidateUICommand.

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

IUICommandHandler

Exemples d’infrastructure du ruban Windows