Evento HelpComplete

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

Descrição

Indica que o modo de Ajuda sensível ao contexto foi encerrado.

Sintaxe

Subagent.(ByValCharacterID**, ByVal** Name**, ByVal** Cause**)**

Parte	Descrição
CharacterID	Retorna a ID do caractere clicado como uma cadeia de caracteres.
Nome	Retorna um valor de cadeia de caracteres que identifica o nome (ID) do comando.
Causa	Retorna um valor que indica o que causou a conclusão do modo de Ajuda. 1 O usuário selecionou um comando fornecido pelo aplicativo. 2 O usuário selecionou o objeto Commands de outro cliente. 3 O usuário selecionou o comando Open Voice Commands. 4 O usuário selecionou o comando Close Voice Commands. 5 O usuário selecionou o comando Show CharacterName. 6 O usuário selecionou o comando Hide CharacterName. 7 O usuário selecionou o (clicou no) caractere.

Comentários

Normalmente, o modo de Ajuda é concluído quando o usuário clica ou arrasta o caractere ou seleciona um comando no menu pop-up do caractere. Clicar em outro caractere ou em outro lugar da tela não cancela o modo de Ajuda. O cliente que definiu o modo de Ajuda para o caractere pode cancelar o modo de Ajuda definindo HelpModeOn como False. (Isso não aciona o evento HelpComplete.)

Quando o usuário seleciona um comando no menu pop-up do caractere no modo de Ajuda, o servidor remove o menu, chama a Ajuda com o HelpContextID especificado do comando e envia esse evento. A janela Ajuda sensível ao contexto (também conhecida como O que é isso?) é exibida no local do ponteiro. Se o usuário selecionar o comando por entrada de voz, a janela Ajuda será exibida sobre o caractere. Se o caractere estiver fora da tela, a janela será exibida na tela mais próxima da posição atual do caractere.

Se o servidor retornar Name como uma cadeia de caracteres vazia (""), isso indicará que o usuário selecionou um comando fornecido pelo servidor.

Esse evento será enviado somente para o aplicativo cliente que coloca o caractere no modo de Ajuda.

Confira também

HelpModeOn property, Propriedade HelpContextID