Méthode IOleDocumentSite ::ActivateMe (docobj.h)

Article
02/28/2024

Demande à un site de documents d’activer le document faisant l’appel en tant qu’objet de document plutôt que comme objet actif sur place et, éventuellement, spécifie la vue du document objet à activer.

Syntaxe

HRESULT ActivateMe(
  [in] IOleDocumentView *pViewToActivate
);

Paramètres

[in] pViewToActivate

Pointeur vers un pointeur d’interface IOleDocumentView qui représente la vue de document à utiliser pour activer l’objet document. Ce paramètre peut être NULL, auquel cas le conteneur doit appeler IOleDocument ::CreateView pour obtenir un pointeur d’affichage de document.

Valeur retournée

Cette méthode retourne S_OK en cas de réussite.

Remarques

Lorsqu’un conteneur appelle IOleObject ::D oVerb pour activer un document, un objet document contourne la séquence d’activation sur place habituelle en appelant IOleDocumentSite ::ActivateMe.

Lorsque vous appelez IOleObject ::D oVerb sur un objet de document, le verbe d’activation le plus approprié est généralement OLEIVERB_SHOW. Les autres verbes autorisés incluent OLEIVERB_PRIMARY et OLEIVERB_UIACTIVATE. OLEIVERB_OPEN est déconseillé, car il s’agit d’ouvrir un objet incorporé dans une fenêtre distincte, ce qui est contraire à l’intention de l’activation d’un objet de document.

Notes aux appelants

Seuls les objets de document doivent appeler cette méthode. Un document actif sur place normal doit répondre à l’appel d’un conteneur à IOleObject ::D oVerb en appelant IOleInPlaceSite.

Un objet document doit lancer son activation en appelant IOleDocumentSite ::ActivateMe. Si le conteneur n’implémente pas IOleDocumentSite, le document doit utiliser par défaut la séquence d’activation sur place normale.

Un objet document qui prend en charge plusieurs vues de ses données peut spécifier la vue à activer en passant un pointeur vers l’interface IOleDocumentView de cet affichage dans pViewToActivate.

Même si le pointeur IOleDocumentView est obtenu, le conteneur doit libérer le pointeur lorsqu’il n’est plus nécessaire.

Notes aux implémenteurs

Cette fonction doit être complètement implémentée dans un conteneur d’objets de document ; E_NOTIMPL n’est pas une valeur de retour acceptable.

Si un objet document transmet un pointeur IOleDocumentView dans pViewToActivate, l’implémentation du conteneur de IOleDocumentSite ::ActivateMe doit appeler IOleDocumentView ::SetInPlaceSite et passer un pointeur vers son interface IOleInPlaceSite à l’objet d’affichage. Si le conteneur maintient le pointeur IOleDocumentView , ce qui est normalement le cas, il doit suivre l’appel à IOleDocumentView ::SetInPlaceSite avec un appel à IUnknown ::AddRef.

Si pViewToActivate a la valeur NULL, le conteneur peut obtenir un pointeur vers une vue de document en interrogeant le document pour IOleDocument, puis en appelant IOleDocument ::CreateView et en passant son pointeur IOleInPlaceSite .

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	docobj.h