IAgentCommand

[Microsoft Agent устарел по состоянию на Windows 7 и может быть недоступен в последующих версиях Windows.]

Объект Command — это элемент в коллекции Commands . Сервер предоставляет пользователю доступ к командам, которые клиентское приложение становится активным. Чтобы получить команду, вызовите IAgentCommands::GetCommand.

IAgentCommand определяет интерфейс, позволяющий приложениям задавать и запрашивать свойства объектов command , которые могут отображаться во всплывающем меню символа и в окне голосовых команд. Эти функции также доступны в IAgentCommandEx. Объект Command — это элемент в коллекции Commands . Сервер предоставляет пользователю доступ к командам, когда клиентское приложение становится активным.

Команда может отображаться во всплывающем меню символа или в окне голосовых команд. Чтобы появиться во всплывающем меню, оно должно иметь заголовок и свойство Visible должно иметь значение True. Свойство Visible для объекта коллекции Commands также должно иметь значение True , чтобы команда отображалась во всплывающем меню, когда клиентское приложение активно. Чтобы появиться в окне голосовых команд, команда должна иметь свои свойства VoiceCaption и Voice . (Для обратной совместимости, если voiceCaption отсутствует, используется параметр caption .)

Во время отображения меню всплывающие элементы символа не изменяются. При добавлении или удалении команд или изменении их свойств во время отображения всплывающего меню символа эти изменения отображаются при повторном воспроизведении. Однако окно голосовых команд отображает изменения при их внесении.

В следующей таблице показано, как свойства команды влияют на ее презентацию.

Свойство Caption	Свойство Voice-Caption	Свойство Voice	Видимое свойство	Отображается во всплывающем меню символа	Отображается в окне голосовых команд
Да	Да	Да	True	Да, использование заголовка	Да, использование VoiceCaption
Да	Да	No¹	True	Да, использование заголовка	нет
Да	Да	Да	Неверно	нет	Да, использование VoiceCaption
Да	Да	No¹	False	нет	нет
No¹	Да	Да	True	нет	Да, использование VoiceCaption
No¹	Да	Да	Неверно	нет	Да, использование VoiceCaption
No¹	Да	No¹	True	нет	нет
No¹	Да	No¹	False	нет	нет
Да	No¹	Да	True	Да, использование заголовка	Да, использование заголовка
Да	No¹	No¹	True	Да	нет
Да	No¹	Да	Неверно	нет	Да, использование заголовка
Да	No¹	No¹	False	нет	нет
No¹	No¹	Да	True	нет	No²
No¹	No¹	Да	False	нет	No²
No¹	No¹	No¹	True	нет	нет
No¹	No¹	No¹	False	нет	нет

 

¹If параметр свойства имеет значение NULL. В некоторых языках программирования пустая строка не может быть интерпретирована как пустая строка.

Команда fxThe по-прежнему доступна для голосовой связи.

Как правило, если вы определяете команду с параметром голосовой связи, вы также определяете параметры субтитров и голосовых параметров для связанной коллекции команд . Если коллекция "Команды " для набора команд не имеет параметра "Голос " или без параметра заголовка и в настоящее время активна, но команды имеют параметры субтитров и голосовой связи, команды отображаются в представлении дерева окна голосовых команд в разделе "(неопределенная команда)", когда клиентское приложение становится активным.

Когда сервер получает входные данные, соответствующие одному из объектов Command, определенных для коллекции Commands, он отправляет событие IAgentNotifySink::Command и передает идентификатор команды в качестве атрибута объекта IAgentUserInput. Затем можно использовать условные инструкции для сопоставления и обработки команды.

Методы в порядке таблицы Vtable

Методы IAgentCommand	Описание
SetCaption	Задает значение заголовка для объекта Command .
GetCaption	Возвращает значение свойства Caption объекта Command .
SetVoice	Задает значение текста голосовой связи для объекта Command .
GetVoice	Возвращает значение свойства Voice объекта Command .
SetEnabled	Задает значение свойства Enabled для объекта Command .
GetEnabled	Возвращает значение свойства Enabled объекта Command .
SetVisible	Задает значение свойства Visible для объекта Command .
GetVisible	Возвращает значение свойства Visible объекта Command .
SetConfidenceThreshold	Задает значение свойства Confidence для объекта Command .
GetConfidenceThreshold	Возвращает значение свойства Confidence объекта Command .
SetConfidenceText	Задает значение свойства ConfidenceText для объекта Command .
getConfidenceText	Возвращает значение свойства ConfidenceText объекта Command .
getID	Возвращает идентификатор объекта Command .