| Platform SDK: Agent |
The server supports the following properties for the Commands collection:
Caption, Count, DefaultCommand, FontName, FontSize, GlobalVoiceCommandsEnabled, HelpContextID, Visible, Voice, VoiceCaption
An entry for the Commands collection can appear in both the pop-up menu and the Voice Commands Window for a character. To make this entry appear in the pop-up menu, set its Caption property. To include the entry in the Voice Commands Window, set its VoiceCaption property. (For backward compatibility, if there is no VoiceCaption, the Caption setting is used)
The following table summarizes how the properties of a Commands object affect the entry's presentation:
| Caption Property | Voice-Caption Property | Voice Property | Visible Property | Appears in Character's Pop-up Menu |
Appears in Voice Commands Window |
|---|---|---|---|---|---|
| Yes | Yes | Yes | True | Yes, using Caption | Yes, using VoiceCaption |
| Yes | Yes | No1 | True | Yes, using Caption | No |
| Yes | Yes | Yes | False | No | Yes, using VoiceCaption |
| Yes | Yes | No1 | False | No | No |
| No1 | Yes | Yes | True | No | Yes, using VoiceCaption |
| No1 | Yes | Yes | False | No | Yes, using VoiceCaption |
| No1 | Yes | No1 | True | No | No |
| No1 | Yes | No1 | False | No | No |
| Yes | No1 | Yes | True | Yes, using Caption | Yes, using Caption |
| Yes | No1 | No1 | True | Yes | No |
| Yes | No1 | Yes | False | No | Yes, using Caption |
| Yes | No1 | No1 | False | No | No |
| No1 | No1 | Yes | True | No | No2 |
| No1 | No1 | Yes | False | No | No2 |
| No1 | No1 | No1 | True | No | No |
| No1 | No1 | No1 | False | No | No |
| 1If the property setting is null. In some programming languages, an empty string may not be interpreted as the same as a null string.
2The command is still voice-accessible, and appears in the Voice Commands Window as "(command undefined)". |
|||||