Partager via

IAgentCommand

  • Article

[Microsoft Agent est déconseillé à partir de Windows 7 et peut être indisponible dans les versions ultérieures de Windows.]

Un objet Command est un élément d’une collection Commands . Le serveur fournit à l’utilisateur l’accès à vos commandes, votre application cliente devient active. Pour récupérer une commande, appelez IAgentCommands::GetCommand.

IAgentCommand définit une interface qui permet aux applications de définir et d’interroger des propriétés pour les objets Command qui peuvent apparaître dans le menu contextuel d’un caractère et dans la fenêtre Commandes vocales. Ces fonctions sont également disponibles à partir de IAgentCommandEx. Un objet Command est un élément d’une collection Commands . Le serveur fournit à l’utilisateur l’accès à vos commandes lorsque votre application cliente devient active.

Une commande peut apparaître dans l’un ou dans le menu contextuel du caractère et dans la fenêtre Commandes vocales. Pour apparaître dans le menu contextuel, il doit avoir une légende et avoir la propriété Visible définie sur True. La propriété Visible de son objet de collection Commands doit également être définie sur True pour que la commande apparaisse dans le menu contextuel lorsque votre application cliente est active en entrée. Pour apparaître dans la fenêtre Commandes vocales, les propriétés VoiceCaption et Voice d’une commande doivent être définies. (Pour la compatibilité descendante, s’il n’existe pas de VoiceCaption, le paramètre Légende est utilisé.)

Les entrées de menu contextuel d’un caractère ne changent pas lorsque le menu s’affiche. Si vous ajoutez ou supprimez des commandes ou modifiez leurs propriétés lorsque le menu contextuel du caractère s’affiche, le menu affiche ces modifications en cas de redisplay. Toutefois, la fenêtre Commandes vocales affiche les modifications que vous apportez.

Le tableau suivant récapitule la façon dont les propriétés d’une commande affectent sa présentation.

Propriété Caption Voice-Caption, propriété Voice, propriété Visible, propriété S’affiche dans le menu contextuel caractère Apparaît dans la fenêtre Commandes vocales
Oui Oui Oui True Oui, à l’aide de la légende Oui, à l’aide de VoiceCaption
Oui Oui No¹ True Oui, à l’aide de la légende Non
Oui Oui Oui False Non Oui, à l’aide de VoiceCaption
Oui Oui No¹ False Non Non
No¹ Oui Oui True Non Oui, à l’aide de VoiceCaption
No¹ Oui Oui False Non Oui, à l’aide de VoiceCaption
No¹ Oui No¹ True Non Non
No¹ Oui No¹ False Non Non
Oui No¹ Oui True Oui, à l’aide de la légende Oui, à l’aide de la légende
Oui No¹ No¹ True Oui Non
Oui No¹ Oui False Non Oui, à l’aide de la légende
Oui No¹ No¹ False Non Non
No¹ No¹ Oui True Non Non²
No¹ No¹ Oui False Non Non²
No¹ No¹ No¹ True Non Non
No¹ No¹ No¹ False Non Non

 

¹Si le paramètre de propriété a la valeur Null. Dans certains langages de programmation, une chaîne vide peut ne pas être interprétée comme une chaîne null.

²La commande est toujours accessible par la voix.

En règle générale, si vous définissez une commande avec un paramètre Voix , vous définissez également les paramètres Légende et Voix pour sa collection Commands associée. Si la collection Commands d’un ensemble de commandes n’a pas de paramètre Voix ou aucune légende et est actuellement active en entrée, mais que les commandes ont des paramètres Légende et Voix , les commandes apparaissent dans l’arborescence de la fenêtre Commandes vocales sous « (commande non définie) » lorsque votre application cliente devient active en entrée.

Lorsque le serveur reçoit une entrée qui correspond à l’un des objets Command que vous avez définis pour votre collection Commands , il envoie un événement IAgentNotifySink::Command et transmet l’ID de la commande en tant qu’attribut de l’objet IAgentUserInput . Vous pouvez ensuite utiliser des instructions conditionnelles pour faire correspondre et traiter la commande.

Méthodes dans l'ordre Vtable

Méthodes IAgentCommand Description
SetCaption Définit la valeur de la légende d’un objet Command .
GetCaption Retourne la valeur de la propriété Caption d’un objet Command .
SetVoice Définit la valeur du texte Voice pour un objet Command .
GetVoice Retourne la valeur de la propriété Voice d’un objet Command .
SetEnabled Définit la valeur de la propriété Enabled pour un objet Command .
GetEnabled Retourne la valeur de la propriété Enabled d’un objet Command .
SetVisible Définit la valeur de la propriété Visible pour un objet Command .
GetVisible Retourne la valeur de la propriété Visible d’un objet Command .
SetConfidenceThreshold Définit la valeur de la propriété Confidence pour un objet Command .
GetConfidenceThreshold Retourne la valeur de la propriété Confidence d’un objet Command .
SetConfidenceText Définit la valeur de la propriété ConfidenceText pour un objet Command .
getConfidenceText Retourne la valeur de la propriété ConfidenceText d’un objet Command .
getID Retourne l’ID d’un objet Command .