IAgentCommand
[Microsoft Agent está en desuso a partir de Windows 7 y puede no estar disponible en versiones posteriores de Windows].
Un objeto Command es un elemento de una colección Commands . El servidor proporciona al usuario acceso a los comandos a los que la aplicación cliente pasa a estar activa. Para recuperar un comando, llame a IAgentCommands::GetCommand.
IAgentCommand define una interfaz que permite a las aplicaciones establecer y consultar las propiedades de los objetos Command que pueden aparecer en el menú emergente de un carácter y en la ventana Comandos de voz. Estas funciones también están disponibles en IAgentCommandEx. Un objeto Command es un elemento de una colección Commands . El servidor proporciona al usuario acceso a los comandos cuando la aplicación cliente pasa a estar activa.
Un comando puede aparecer en el menú emergente del carácter o en la ventana Comandos de voz. Para que aparezca en el menú emergente, debe tener un título y tener la propiedad Visible establecida en True. La propiedad Visible para su objeto de colección Commands también debe establecerse en True para que el comando aparezca en el menú emergente cuando la aplicación cliente esté input-active. Para aparecer en la ventana Comandos de voz, un comando debe tener establecidas sus propiedades VoiceCaption y Voice . (Para la compatibilidad con versiones anteriores, si no hay voiceCaption, se usa la configuración de título ).
Las entradas del menú emergente de un carácter no cambian mientras se muestra el menú. Si agrega o quita comandos o cambia sus propiedades mientras se muestra el menú emergente del carácter, el menú muestra esos cambios cuando se vuelve a reproducir. Sin embargo, la ventana Comandos de voz muestra los cambios a medida que los realiza.
En la tabla siguiente se resume cómo afectan las propiedades de un comando a su presentación.
| Propiedad Caption | Voice-Caption (propiedad) | Voice (propiedad) | Visible (propiedad) | Aparece en el menú emergente del carácter | Aparece en la ventana Comandos de voz |
|---|---|---|---|---|---|
| Sí | Sí | Sí | True | Sí, mediante caption | Sí, mediante VoiceCaption |
| Sí | Sí | No¹ | True | Sí, mediante caption | No |
| Sí | Sí | Sí | False | No | Sí, mediante VoiceCaption |
| Sí | Sí | No¹ | False | No | No |
| No¹ | Sí | Sí | True | No | Sí, mediante VoiceCaption |
| No¹ | Sí | Sí | False | No | Sí, mediante VoiceCaption |
| No¹ | Sí | No¹ | True | No | No |
| No¹ | Sí | No¹ | False | No | No |
| Sí | No¹ | Sí | True | Sí, mediante caption | Sí, mediante caption |
| Sí | No¹ | No¹ | True | Sí | No |
| Sí | No¹ | Sí | False | No | Sí, mediante caption |
| Sí | No¹ | No¹ | False | No | No |
| No¹ | No¹ | Sí | True | No | No² |
| No¹ | No¹ | Sí | False | No | No² |
| No¹ | No¹ | No¹ | True | No | No |
| No¹ | No¹ | No¹ | False | No | No |
¹Si el valor de la propiedad es null. En algunos lenguajes de programación, es posible que una cadena vacía no se interprete como la misma que una cadena nula.
²El comando sigue siendo accesible por voz.
Por lo general, si define un comando con una configuración de voz , también define la configuración de título y voz para su colección de comandos asociada. Si la colección Commands de un conjunto de comandos no tiene ninguna configuración voz o ningún título y está activa actualmente, pero los comandos tienen la configuración de título y voz , los comandos aparecen en la vista de árbol ventana comandos de voz en "(comando sin definir)" cuando la aplicación cliente se convierte en input-active.
Cuando el servidor recibe la entrada que coincide con uno de los objetos Command definidos para la colección Commands , envía un evento IAgentNotifySink::Command y pasa el identificador del comando como atributo del objeto IAgentUserInput . Después, puede usar instrucciones condicionales para buscar coincidencias y procesar el comando.
Métodos en orden de Vtable
| Métodos IAgentCommand | Descripción |
|---|---|
| SetCaption | Establece el valor de Caption para un objeto Command . |
| GetCaption | Devuelve el valor de la propiedad Caption de un objeto Command . |
| SetVoice | Establece el valor del texto de voz de un objeto Command . |
| GetVoice | Devuelve el valor de la propiedad Voice de un objeto Command . |
| SetEnabled | Establece el valor de la propiedad Enabled para un objeto Command . |
| GetEnabled | Devuelve el valor de la propiedad Enabled de un objeto Command . |
| SetVisible | Establece el valor de la propiedad Visible para un objeto Command . |
| GetVisible | Devuelve el valor de la propiedad Visible de un objeto Command . |
| SetConfidenceThreshold | Establece el valor de la propiedad Confidence para un objeto Command . |
| GetConfidenceThreshold | Devuelve el valor de la propiedad Confidence de un objeto Command . |
| SetConfidenceText | Establece el valor de la propiedad ConfidenceText para un objeto Command . |
| getConfidenceText | Devuelve el valor de la propiedad ConfidenceText de un objeto Command . |
| getID | Devuelve el identificador de un objeto Command . |