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

Artigo
08/23/2023

Solicita que um site de documento ative o documento que faz a chamada como um objeto de documento em vez de um objeto in-loco-ativo e, opcionalmente, especifica qual exibição do documento de objeto será ativada.

Sintaxe

HRESULT ActivateMe(
  [in] IOleDocumentView *pViewToActivate
);

Parâmetros

[in] pViewToActivate

Um ponteiro para um ponteiro de interface IOleDocumentView que representa a exibição do documento a ser usada na ativação do objeto de documento. Esse parâmetro pode ser NULL; nesse caso, o contêiner deve chamar IOleDocument::CreateView para obter um ponteiro de exibição de documento.

Retornar valor

Esse método retorna S_OK em caso de êxito.

Comentários

Quando um contêiner chama IOleObject::D oVerb para ativar um documento, um objeto de documento ignora a sequência de ativação in-loco usual chamando IOleDocumentSite::ActivateMe.

Ao chamar IOleObject::D oVerb em um objeto de documento, o verbo de ativação mais apropriado geralmente é OLEIVERB_SHOW. Outros verbos permitidos incluem OLEIVERB_PRIMARY e OLEIVERB_UIACTIVATE. OLEIVERB_OPEN é desencorajado porque significa abrir um objeto inserido em uma janela separada, o que é contrário à intenção de ativação de objeto do documento.

Anotações aos Chamadores

Somente objetos de documento devem chamar esse método. Um documento ativo in-loco normal deve responder à chamada de um contêiner para IOleObject::D oVerb chamando IOleInPlaceSite.

Um objeto de documento deve iniciar sua ativação chamando IOleDocumentSite::ActivateMe. Se o contêiner não implementar IOleDocumentSite, o documento deverá usar como padrão a sequência de ativação in-loco normal.

Um objeto de documento que dá suporte a mais de uma exibição de seus dados pode especificar qual exibição ativar passando um ponteiro para a interface IOleDocumentView dessa exibição em pViewToActivate.

No entanto, o ponteiro IOleDocumentView é obtido, o contêiner deve liberar o ponteiro quando ele não for mais necessário.

Observações aos implementadores

Essa função deve ser completamente implementada em um contêiner de objeto de documento; E_NOTIMPL não é um valor retornado aceitável.

Se um objeto de documento passar um ponteiro IOleDocumentView em pViewToActivate, a implementação do contêiner de IOleDocumentSite::ActivateMe deverá chamar IOleDocumentView::SetInPlaceSite e passar um ponteiro para sua interface IOleInPlaceSite de volta para o objeto de exibição. Se o contêiner estiver segurando o ponteiro IOleDocumentView , que normalmente será o caso, ele deverá seguir a chamada para IOleDocumentView::SetInPlaceSite com uma chamada para IUnknown::AddRef.

Se pViewToActivate for NULL, o contêiner poderá obter um ponteiro para uma exibição de documento consultando o documento para IOleDocument, chamando IOleDocument::CreateView e passando seu ponteiro IOleInPlaceSite .

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	docobj.h