Partilhar via


IAgentCommand

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

Um objetoCommandé um item em uma coleçãoCommands. O servidor fornece ao usuário acesso aos seus comandos, seu aplicativo cliente torna-se entrada ativa. Para recuperar um de comando, chame IAgentCommands::GetCommand.

IAgentCommand define uma interface que permite que os aplicativos definam e consultem propriedades para Command objetos 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çãoCommands. O servidor fornece ao usuário acesso aos comandos quando o aplicativo cliente se torna ativo de entrada.

Umde Comandospode aparecer no menu pop-up do personagem e na janela Comandos de voz. Para aparecer no menu pop-up, ele deve ter umaCaptione ter a propriedade Visible definida como True. A propriedade Visible para seu objeto de 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 de entrada. Para aparecer na janela Comandos de voz, um de comando deve ter suas VoiceCaption e propriedades de de voz definidas. (Para compatibilidade com versões anteriores, se não houver VoiceCaption , a configuração Caption 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 é exibido, o menu exibirá essas alterações quando reexibido. No entanto, a janela Comandos de voz exibe as alterações à medida que você as faz.

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

Propriedade Caption Voice-Caption Propriedade Propriedade Voice Propriedade visível Aparece no menu pop-up do personagem Aparece na janela Comandos de voz
Sim Sim Sim Verdadeiro Sim, usando Caption Sim, usando VoiceCaption
Sim Sim Não¹ Verdadeiro Sim, usando Caption Não
Sim Sim Sim Falso Não Sim, usando VoiceCaption
Sim Sim Não¹ Falso Não Não
Não¹ Sim Sim Verdadeiro Não Sim, usando VoiceCaption
Não¹ Sim Sim Falso Não Sim, usando VoiceCaption
Não¹ Sim Não¹ Verdadeiro Não Não
Não¹ Sim Não¹ Falso Não Não
Sim Não¹ Sim Verdadeiro Sim, usando Caption Sim, usando Caption
Sim Não¹ Não¹ Verdadeiro Sim Não
Sim Não¹ Sim Falso Não Sim, usando Caption
Sim Não¹ Não¹ Falso Não Não
Não¹ Não¹ Sim Verdadeiro Não Não²
Não¹ Não¹ Sim Falso Não Não²
Não¹ Não¹ Não¹ Verdadeiro Não Não
Não¹ Não¹ Não¹ Falso Não Não

 

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

²O comando ainda é acessível por voz.

Geralmente, se você definir umade Comandocom uma configuração dede Voz, também definirá de Legenda e configurações de de Voz para sua coleção deComandos deassociada. Se a coleção de Comandos para um conjunto de comandos não tiver de Voz ou nenhuma configuração de de Legenda e estiver atualmente ativa de entrada, mas os Comandos tiverem de Legenda e configurações de de Voz, os Comandos de aparecerão na visualização de árvore da Janela de Comandos de Voz em "(comando indefinido)" quando seu aplicativo cliente se tornar ativo de entrada.

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

Métodos em Vtable Order

Métodos IAgentCommand Descrição
SetCaption Define o valor doCaptionde um objetoCommand.
GetCaption Retorna o valor da propriedade Caption de um objetoCommand.
SetVoice Define o valor do texto Voice para um objeto Command.
GetVoice Retorna o valor da propriedade Voice de um objetoCommand.
SetEnabled Define o valor da propriedade Enabled para um objeto Command.
GetEnabled Retorna o valor da propriedade Enabled de um objetoCommand.
SetVisible Define o valor da propriedade Visible para um objeto Command.
GetVisible Retorna o valor da propriedade Visible de um objetoCommand.
SetConfidenceThreshold Define o valor da propriedade Confidence para um Command objeto.
GetConfidenceThreshold Retorna o valor da propriedade Confidence de um objetoCommand.
SetConfidenceText Define o valor da propriedade ConfidenceText para um Command objeto.
getConfidenceText Retorna o valor da propriedade ConfidenceText de um objetoCommand.
getID Retorna a ID de um Command objeto.