Método IOleDocumentView::UIActivate (docobj.h)

Artigo
08/23/2023

Ativa ou desativa os elementos de interface do usuário de uma exibição de documento, como menus, barras de ferramentas e aceleradores.

Sintaxe

HRESULT UIActivate(
  [in] BOOL fUIActivate
);

Parâmetros

[in] fUIActivate

Se TRUE, a exibição será ativar sua interface do usuário. Se FALSE, a exibição será desativar sua interface do usuário.

Valor retornado

Esse método retorna S_OK com êxito. Outros valores retornados possíveis incluem o seguinte.

Código de retorno	Descrição
E_FAIL	Falha na operação.
E_OUTOFMEMORY	Memória insuficiente disponível para operação.
E_UNEXPECTED	Erro inesperado.

Comentários

Anotações para chamadores

Chamar esse método antes de chamar IOleDocumentView::SetInPlaceSite retorna E_UNEXPECTED, pois o modo de exibição deve ser associado a um site de exibição antes que ele possa se ativar.

Quando IOleDocumentView::UIActivate é chamado como parte da sequência de ativação, a chamada deve preceder uma chamada para IOleDocumentView::SetRect ou IOleDocumentView::SetRectComplex, pois caso contrário, as dimensões de exibição não contabilizariam o espaço na barra de ferramentas.

Para desativar uma exibição, o contêiner deve chamar IOleDocumentView::Show com FALSE, seguido por IOleDocumentView::UIActivate com FALSE.

Anotações aos implementadores

As implementações desse método devem incorporar o pseudocódigo a seguir.

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

Além disso, o modo de exibição pode e deve participar da mesclagem estendida do menu ajuda .

Todas as exibições de um objeto de documento devem dar suporte à ativação in-loco. E_NOTIMPL não é um valor retornado aceitável.

Requisitos


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