IOleWindow::ContextSensitiveHelp-Methode (oleidl.h)

  • Artikel

Bestimmt, ob der kontextsensitive Hilfemodus während einer direkten Aktivierungssitzung eingegeben werden soll.

Syntax

HRESULT ContextSensitiveHelp(
  [in] BOOL fEnterMode
);

Parameter

[in] fEnterMode

TRUE , wenn der Hilfemodus eingegeben werden soll; FALSE , wenn es beendet werden soll.

Rückgabewert

Diese Methode gibt S_OK zurück, wenn der Hilfemodus je nach dem in fEnterMode übergebenen Wert erfolgreich eingegeben oder beendet wurde. Weitere mögliche Rückgabewerte:

Rückgabecode Beschreibung
E_INVALIDARG
 Der angegebene fEnterMode-Wert ist ungültig.
E_OUTOFMEMORY
 Für diesen Vorgang ist nicht genügend Arbeitsspeicher verfügbar.
E_UNEXPECTED
 Ein unerwarteter Fehler ist aufgetreten.

Hinweise

Anwendungen können kontextsensitive Hilfe aufrufen, wenn der Benutzer:

  • drücken SIE UMSCHALT+F1, und klicken Sie dann auf ein Thema.
  • drückt F1, wenn ein Menüelement ausgewählt ist
Wenn UMSCHALT+F1 gedrückt wird, kann entweder der Frame oder das aktive Objekt die Tastenanschläge empfangen. Wenn der Frame des Containers die Tastenanschläge empfängt, ruft er die IOleWindow::ContextSensitiveHelp-Methode des enthaltenden Dokuments auf, wobei fEnterMode auf TRUE festgelegt ist. Dadurch wird der Hilfezustand an alle direkten Objekte weitergegeben, damit sie den Mausklick oder die WM_COMMAND ordnungsgemäß verarbeiten können.

Wenn ein aktives Objekt die UMSCHALT+F1-Tastenanschläge empfängt, ruft es die IOleWindow::ContextSensitiveHelp-Methode des Containers mit fEnterModeTRUE auf, die dann rekursiv jeden seiner direkten Standorte aufruft, bis keine weiteren Benachrichtigungen mehr vorhanden sind. Der Container ruft dann die IOleWindow::ContextSensitiveHelp-Methode seines Dokuments oder Frames mit fEnterModeTRUE auf.

Im kontextabhängigen Hilfemodus kann ein Objekt, das den Mausklick empfängt, folgendes:

  • Ignorieren Sie den Klick, wenn sie keine kontextbezogene Hilfe unterstützt.
  • Weisen Sie alle anderen Objekte an, den kontextsensitiven Hilfemodus zu beenden, wobei ContextSensitiveHelp auf FALSE festgelegt ist, und dann Hilfe für diesen Kontext bereitstellen.
Ein Objekt im kontextsensitiven Hilfemodus, das eine WM_COMMAND empfängt, sollte alle anderen direkten Objekte anweisen, den kontextsensitiven Hilfemodus zu beenden und dann Hilfe für den Befehl bereitzustellen.

Wenn eine Containeranwendung kontextsensitive Hilfe zu Menüelementen unterstützen soll, muss sie entweder einen eigenen Nachrichtenfilter bereitstellen, damit sie den F1-Schlüssel abfangen kann, oder die OLE-Bibliothek bitten, einen Nachrichtenfilter hinzuzufügen, indem sie OleSetMenuDescriptor aufruft und gültige Werte ohne NULL für die Parameter lpFrame und lpActiveObj übergibt.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile oleidl.h

Weitere Informationen

IOleWindow

OleSetMenuDescriptor