IAgentCommand

[Microsoft Agent tidak digunakan lagi pada Windows 7, dan mungkin tidak tersedia dalam versi Windows berikutnya.]

ObjekPerintahadalah item dalam kumpulanPerintah. Server menyediakan akses pengguna ke perintah Anda, aplikasi klien Anda menjadi aktif input. Untuk mengambil Perintah, panggil IAgentCommands::GetCommand.

IAgentCommand menentukan antarmuka yang memungkinkan aplikasi mengatur dan mengkueri properti untuk objekPerintahyang dapat muncul di menu pop-up karakter dan di Jendela Perintah Suara. Fungsi-fungsi ini juga tersedia dari IAgentCommandEx. Objek Perintah adalah item dalam kumpulanPerintah. Server menyediakan akses pengguna ke perintah Anda saat aplikasi klien Anda menjadi aktif input.

Perintah dapat muncul di menu pop-up karakter dan Jendela Perintah Suara. Untuk muncul di menu pop-up, harus memilikiKeterangandan propertiTerlihatdiatur ke True. Properti Terlihat untuk objek pengumpulanPerintahjuga harus diatur ke True agar perintah muncul di menu pop-up saat aplikasi klien Anda aktif input. Untuk muncul di Jendela Perintah Suara, Perintah harus mengatur propertiVoiceCaption dan Voice. (Untuk kompatibilitas mundur, jika tidak ada VoiceCaption, pengaturan Keterangan digunakan.)

Entri menu pop-up karakter tidak berubah saat menu ditampilkan. Jika Anda menambahkan atau menghapus Perintah atau mengubah propertinya saat menu popup karakter ditampilkan, menu menampilkan perubahan tersebut saat diputar ulang. Namun, Jendela Perintah Suara memang menampilkan perubahan saat Anda membuatnya.

Tabel berikut ini meringkas bagaimana properti perintah memengaruhi presentasinya.

Properti Keterangan	Properti Voice-Caption	Properti Suara	Properti Terlihat	Muncul di Menu Pop-up Karakter	Muncul di Jendela Perintah Suara
Ya	Ya	Ya	Benar	Ya, menggunakanKeterangan	Ya, menggunakanVoiceCaption
Ya	Ya	Tidak¹	Benar	Ya, menggunakanKeterangan	Tidak
Ya	Ya	Ya	Palsu	Tidak	Ya, menggunakanVoiceCaption
Ya	Ya	Tidak¹	Palsu	Tidak	Tidak
Tidak¹	Ya	Ya	Benar	Tidak	Ya, menggunakanVoiceCaption
Tidak¹	Ya	Ya	Palsu	Tidak	Ya, menggunakanVoiceCaption
Tidak¹	Ya	Tidak¹	Benar	Tidak	Tidak
Tidak¹	Ya	Tidak¹	Palsu	Tidak	Tidak
Ya	Tidak¹	Ya	Benar	Ya, menggunakanKeterangan	Ya, menggunakanKeterangan
Ya	Tidak¹	Tidak¹	Benar	Ya	Tidak
Ya	Tidak¹	Ya	Palsu	Tidak	Ya, menggunakanKeterangan
Ya	Tidak¹	Tidak¹	Palsu	Tidak	Tidak
Tidak¹	Tidak¹	Ya	Benar	Tidak	Tidak²
Tidak¹	Tidak¹	Ya	Palsu	Tidak	Tidak²
Tidak¹	Tidak¹	Tidak¹	Benar	Tidak	Tidak
Tidak¹	Tidak¹	Tidak¹	Palsu	Tidak	Tidak

 

¹Jika pengaturan properti null. Dalam beberapa bahasa pemrograman, string kosong mungkin tidak ditafsirkan sama dengan string null.

² Perintah masih dapat diakses suara.

Umumnya, jika Anda menentukanPerintahdengan pengaturanSuara, Anda juga menentukan pengaturan Keterangan dan Voice untuk koleksiPerintahterkait. Jika kumpulan Perintah untuk sekumpulan perintah tidak memiliki pengaturan Voice atau tanpa Keterangan dan saat ini aktif input, tetapi Perintah memiliki pengaturan Keterangan dan Voice, perintah muncul di tampilan pohon Jendela Perintah Suara di bawah "(perintah yang tidak ditentukan)" saat aplikasi klien Anda menjadi input-aktif.

Ketika server menerima input yang cocok dengan salah satu objekPerintahyang Anda tentukan untuk kumpulanPerintahAnda, server mengirimkan peristiwa IAgentNotifySink::Command, dan meneruskan kembali ID perintah sebagai atribut objek IAgentUserInput. Anda kemudian dapat menggunakan pernyataan bersyarah untuk mencocokkan dan memproses perintah.

Metode dalam Urutan Vtable

Metode IAgentCommand	Deskripsi
SetCaption	Mengatur nilai untukKeteranganuntuk objekPerintah.
GetCaption	Mengembalikan nilai propertiKeterangandari objekPerintah.
SetVoice	Mengatur nilai untuk teksSuarauntuk objekPerintah.
GetVoice	Mengembalikan nilai propertiSuaradari objekPerintah.
SetEnabled	Mengatur nilai propertiDiaktifkan untuk objekPerintah.
GetEnabled	Mengembalikan nilai propertiDiaktifkan dari objekPerintah.
SetVisible	Mengatur nilai propertiTerlihat untuk objekPerintah.
GetVisible	Mengembalikan nilai propertiTerlihat dari objekPerintah.
SetConfidenceThreshold	Mengatur nilai propertiKeyakinanuntuk objekPerintah.
GetConfidenceThreshold	Mengembalikan nilai propertiKeyakinandari objekPerintah.
SetConfidenceText	Mengatur nilai propertiConfidenceText untuk objekPerintah.
getConfidenceText	Mengembalikan nilai propertiConfidenceText dari objekPerintah.
getID	Mengembalikan ID objekPerintah.