Método IOleWindow::ContextSensitiveHelp (oleidl.h)

  • Artigo

Determina se o modo de ajuda contextual deve ser inserido durante uma sessão de ativação in-loco.

Sintaxe

HRESULT ContextSensitiveHelp(
  [in] BOOL fEnterMode
);

Parâmetros

[in] fEnterMode

TRUE se o modo de ajuda deve ser inserido; FALSE se ele deve ser encerrado.

Retornar valor

Esse método retornará S_OK se o modo de ajuda tiver sido inserido ou encerrado com êxito, dependendo do valor passado em fEnterMode. Outros valores retornados possíveis incluem o seguinte.

Código de retorno Descrição
E_INVALIDARG
 O valor fEnterMode especificado não é válido.
E_OUTOFMEMORY
 Não há memória suficiente disponível para esta operação.
E_UNEXPECTED
 Ocorreu um erro inesperado.

Comentários

Os aplicativos podem invocar ajuda contextual quando o usuário:

  • pressiona SHIFT+F1 e clica em um tópico
  • pressiona F1 quando um item de menu é selecionado
Quando SHIFT+F1 é pressionado, o quadro ou o objeto ativo pode receber os pressionamentos de tecla. Se o quadro do contêiner receber os pressionamentos de tecla, ele chamará o método IOleWindow::ContextSensitiveHelp do documento contendo com fEnterMode definido como TRUE. Isso propaga o estado de ajuda para todos os seus objetos in-loco para que eles possam lidar corretamente com o clique do mouse ou WM_COMMAND.

Se um objeto ativo receber os pressionamentos de tecla SHIFT+F1, ele chamará o método IOleWindow::ContextSensitiveHelp do contêiner com fEnterModeTRUE, que chama recursivamente cada um de seus sites in-loco até que não haja mais para ser notificado. Em seguida, o contêiner chama o método IOleWindow::ContextSensitiveHelp de seu documento ou quadro com fEnterModeTRUE.

Quando estiver no modo de ajuda contextual, um objeto que recebe o clique do mouse poderá:

  • Ignore o clique se ele não der suporte à ajuda contextual.
  • Diga a todos os outros objetos para sair do modo de ajuda contextual com ContextSensitiveHelp definido como FALSE e, em seguida, forneça ajuda para esse contexto.
Um objeto no modo de ajuda contextual que recebe uma WM_COMMAND deve informar a todos os outros objetos in-loco para sair do modo de ajuda contextual e, em seguida, fornecer ajuda para o comando.

Se um aplicativo de contêiner der suporte a ajuda contextual em itens de menu, ele deverá fornecer seu próprio filtro de mensagem para que possa interceptar a chave F1 ou pedir à biblioteca OLE para adicionar um filtro de mensagem chamando OleSetMenuDescriptor, passando valores válidos e não NULL para os parâmetros lpFrame e lpActiveObj .

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 oleidl.h

Confira também

Iolewindow

OleSetMenuDescriptor