IOleDocumentView::UIActivate-Methode (docobj.h)

Artikel
08/23/2023

Aktiviert oder deaktiviert die Benutzeroberflächenelemente einer Dokumentansicht, z. B. Menüs, Symbolleisten und Zugriffstasten.

Syntax

HRESULT UIActivate(
  [in] BOOL fUIActivate
);

Parameter

[in] fUIActivate

Wenn TRUE, soll die Ansicht ihre Benutzeroberfläche aktivieren. Bei FALSE wird die Benutzeroberfläche der Ansicht deaktiviert.

Rückgabewert

Diese Methode gibt S_OK bei Erfolg zurück. Weitere mögliche Rückgabewerte:

Rückgabecode	Beschreibung
E_FAIL	Fehler beim Vorgang.
E_OUTOFMEMORY	Unzureichender Arbeitsspeicher für den Betrieb.
E_UNEXPECTED	Ein unerwarteter Fehler ist aufgetreten.

Hinweise

Hinweise für Anrufer

Durch Aufrufen dieser Methode vor dem Aufruf von IOleDocumentView::SetInPlaceSite wird E_UNEXPECTED zurückgegeben, da die Ansicht einer Ansichtswebsite zugeordnet werden muss, bevor sie sich selbst aktivieren kann.

Wenn IOleDocumentView::UIActivate als Teil der Aktivierungssequenz aufgerufen wird, sollte der Aufruf einem Aufruf von IOleDocumentView::SetRect oder IOleDocumentView::SetRectComplex vorangestellt werden, da andernfalls die Ansichtsdimensionen den Symbolleistenbereich nicht berücksichtigen würden.

Um eine Ansicht zu deaktivieren, sollte der Container IOleDocumentView::Show mit FALSE aufrufen, gefolgt von IOleDocumentView::UIActivate with FALSE.

Hinweise für Implementierer

Implementierungen dieser Methode sollten den folgenden Pseudocode verkörpern.

if (fActivate)
    {
    UI activate the view (do menu merging, show frame level tools, process accelerators)
    Take focus, and bring the view window forward.
    }
else
    call IOleInPlaceObject::UIDeactivate on this view

Darüber hinaus kann und sollte die Ansicht am erweiterten Zusammenführen von Hilfemenüs teilnehmen.

Alle Ansichten eines Dokumentobjekts müssen die direkte Aktivierung unterstützen. E_NOTIMPL ist kein zulässiger Rückgabewert.

Anforderungen


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