Partilhar via


IAgentCharacterEx::SetHelpModeOn

[O Microsoft Agent foi preterido a partir do Windows 7 e pode não estar disponível em versões subsequentes do Windows.]

HRESULT SetHelpModeOn(
   long bHelpModeOn  // help mode setting
);

Define o modo de Ajuda sensível ao contexto para o personagem.

  • Retorna S_OK para indicar que a operação foi bem-sucedida.

bHelpModeOn

Sinalizador do modo de ajuda. Se esse parâmetro for True, o Microsoft Agent ativará o modo de Ajuda para o caractere.

Quando você define essa propriedade como True, o ponteiro do mouse muda para a imagem da Ajuda sensível ao contexto quando movido sobre o caractere ou sobre o menu pop-up do caractere. Quando o usuário clica ou arrasta o caractere ou clica em um item no menu pop-up do caractere, o servidor aciona o evento IAgentNotifySinkEx::HelpComplete e sai do modo de Ajuda.

No modo de Ajuda, o servidor não envia os Click, DragStart, DragCompletee Command eventos, a menos que a propriedade GetAutoPopupMenu retorne True. Nesse caso, o servidor enviará o evento Click (não sai do modo de Ajuda), mas apenas para o botão direito do mouse para que você possa exibir o menu pop-up.

Esta propriedade aplica-se apenas ao uso do caractere pelo seu aplicativo cliente; A configuração não afeta outros clientes do caractere ou outros caracteres do seu aplicativo cliente.

Ver também

IAgentCharacterEx::GetHelpModeOn IAgentNotifySinkEx::HelpComplete