IUIFramework::InvalidateUICommand-Methode (uiribbon.h)

Ungültig macht ein Windows-Menübandframework Command-Eigenschaft, -Wert oder -Zustand.

Syntax

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

Parameter

[in] commandId

Typ: UINT32

Die ID für den Befehl, der in der Markupressourcendatei angegeben wird.

[in] flags

Typ: UI_INVALIDATIONS

Gibt an, welcher Aspekt eines Befehls ungültig werden soll.

Hinweis Durch das Übergeben UI_INVALIDATIONS_ALLPROPERTIES werden alle an einen Befehl gebundenen Eigenschaften ungültig, einschließlich Wert und Zustand.
 

[in] key

Typ: const PROPERTYKEY*

Der Eigenschaftsschlüssel der Befehlseigenschaft oder des Befehlszustands. Dieser Parameter kann NULL sein.

Rückgabewert

Typ: HRESULT

Gibt bei erfolgreicher Ausführung S_OK zurück. andernfalls ein Fehlerwert aus der folgenden Liste.

Wert Beschreibung
E_INVALIDARG Ein ungültiger Wert für den Schlüssel wurde angegeben.
E_FAIL Fehler beim Vorgang. Alle Befehle konnten nicht ungültig werden, oder keine der angegebenen Eigenschaften wird unterstützt.

Hinweise

Die im Menübandframework-Markup definierten Ressourcen werden in einer Ressourcentabelle gespeichert, die erstellt wird, wenn die Markupdatei in das Binärformat kompiliert wird. Eine Ressource kann nicht aus der Markupressourcentabelle wiederhergestellt werden, nachdem sie ungültig wurde.

Nach der Ungültigheit fragt das Framework die Hostanwendung nach den Ressourcendetails ab.

Wenn ein Command-Wert ungültig ist (Flags enthalten UI_INVALIDATIONS_VALUE), ist der Wert des SchlüsselsNULL.

Wenn IUIFramework::InvalidateUICommand mehrmals aufgerufen wird und der in jedem Aufruf übergebene UI_INVALIDATIONS Wert überlappende Eigenschaften angibt, z. B. UI_INVALIDATIONS_STATE und UI_INVALIDATIONS_ALLPROPERTIES, wird nur ein Rückruf für die Hostanwendung erstellt.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 7 [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 R2 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile uiribbon.h
DLL Mshtml.dll

Weitere Informationen

IUIFramework

UI_INVALIDATIONS

Windows-Menübandframeworkbeispiele