Compartilhar via


IAgentCommand

[O Microsoft Agent foi preterido a partir do Windows 7 e pode estar indisponível nas versões subsequentes do Windows.]

Um objeto Command é um item em uma coleção Commands . O servidor fornece ao usuário acesso aos comandos que seu aplicativo cliente torna a entrada ativa. Para recuperar um Comando, chame IAgentCommands::GetCommand.

IAgentCommand define uma interface que permite aos aplicativos definir e consultar propriedades para objetos Command que podem aparecer no menu pop-up de um caractere e na janela Comandos de Voz. Essas funções também estão disponíveis em IAgentCommandEx. Um objeto Command é um item em uma coleção Commands . O servidor fornece ao usuário acesso aos seus comandos quando o aplicativo cliente se torna ativo de entrada.

Um Comando pode aparecer no menu pop-up do caractere ou na janela Comandos de Voz. Para aparecer no menu pop-up, ele deve ter uma Legenda e ter a propriedade Visible definida como True. A propriedade Visible do objeto da coleção Commands também deve ser definida como True para que o comando apareça no menu pop-up quando o aplicativo cliente estiver ativo na entrada. Para aparecer na janela Comandos de Voz, um Comando deve ter suas propriedades VoiceCaption e Voice definidas. (Para compatibilidade com versões anteriores, se não houver VoiceCaption, a configuraçãoLegenda será usada.)

As entradas do menu pop-up de um caractere não são alteradas enquanto o menu é exibido. Se você adicionar ou remover Comandos ou alterar suas propriedades enquanto o menu pop-up do caractere for exibido, o menu exibirá essas alterações quando exibidas novamente. No entanto, a janela Comandos de Voz exibe as alterações conforme você as faz.

A tabela a seguir resume como as propriedades de um comando afetam sua apresentação.

Propriedade Caption Propriedade Voice-Caption Propriedade Voice Propriedade Visible Aparece no menu pop-up do caractere Aparece na janela Comandos de Voz
Sim Sim Sim True Sim, usando Legenda Sim, usando o VoiceCaption
Sim Sim Não¹ True Sim, usando Legenda Não
Sim Sim Sim Falso Não Sim, usando o VoiceCaption
Sim Sim Não¹ Falso Não Não
Não¹ Sim Sim True Não Sim, usando o VoiceCaption
Não¹ Sim Sim Falso Não Sim, usando o VoiceCaption
Não¹ Sim Não¹ True Não Não
Não¹ Sim Não¹ Falso Não Não
Sim Não¹ Sim True Sim, usando Legenda Sim, usando Legenda
Sim Não¹ Não¹ True Sim Não
Sim Não¹ Sim Falso Não Sim, usando Legenda
Sim Não¹ Não¹ Falso Não Não
Não¹ Não¹ Sim True Não No²
Não¹ Não¹ Sim Falso Não No²
Não¹ Não¹ Não¹ True Não Não
Não¹ Não¹ Não¹ Falso Não Não

 

¹Se a configuração da propriedade for nula. Em algumas linguagens de programação, uma cadeia de caracteres vazia pode não ser interpretada como a mesma que uma cadeia de caracteres nula.

²O comando ainda é acessível por voz.

Em geral, se você definir um Comando com uma configuração de Voz , também definirá as configurações de Legenda e Voz para sua coleção commands associada. Se a coleção Commands de um conjunto de comandos não tiver nenhuma configuração de Legenda ou voz e estiver ativa de entrada no momento, mas os Comandos tiverem configurações de Legenda e Voz, os Comandos aparecerão na exibição de árvore janela Comandos de Voz em "(comando indefinido)" quando o aplicativo cliente se tornar ativo de entrada.

Quando o servidor recebe uma entrada que corresponde a um dos objetos Command definidos para sua coleção Commands , ele envia um evento IAgentNotifySink::Command e transmite de volta a ID do comando como um atributo do objeto IAgentUserInput . Em seguida, você pode usar instruções condicionais para corresponder e processar o comando.

Métodos na ordem VTable

Métodos IAgentCommand Descrição
SetCaption Define o valor para a Legenda de um objeto Command .
GetCaption Retorna o valor da propriedade Caption de um objeto Command .
SetVoice Define o valor do texto de Voz para um objeto Command .
GetVoice Retorna o valor da propriedade Voice de um objeto Command .
Setenabled Define o valor da propriedade Enabled para um objeto Command .
Getenabled Retorna o valor da propriedade Enabled de um objeto Command .
Setvisible Define o valor da propriedade Visible para um objeto Command .
Getvisible Retorna o valor da propriedade Visible de um objeto Command .
SetConfidenceThreshold Define o valor da propriedade Confidence para um objeto Command .
GetConfidenceThreshold Retorna o valor da propriedade Confidence de um objeto Command .
SetConfidenceText Define o valor da propriedade ConfidenceText para um objeto Command .
getConfidenceText Retorna o valor da propriedade ConfidenceText de um objeto Command .
Getid Retorna a ID de um objeto Command .