Peristiwa HelpComplete

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

Deskripsi

Menunjukkan bahwa mode Bantuan peka konteks telah keluar.

Sintaks

Subagen.(ByValCharacterID**, ByVal** Name**, ByVal** Cause**)**

Bagian	Deskripsi
CHARACTERID	Mengembalikan ID karakter yang diklik sebagai string.
Nama	Mengembalikan nilai string yang mengidentifikasi nama (ID) perintah.
Penyebab	Mengembalikan nilai yang menunjukkan apa yang menyebabkan mode Bantuan selesai. 1 Pengguna memilih perintah yang disediakan oleh aplikasi Anda. 2 Pengguna memilih objek Perintah klien lain. 3 Pengguna memilih perintah Buka Perintah Suara. 4 Pengguna memilih perintah Tutup Perintah Suara. 5 Pengguna memilih perintah Tampilkan CharacterName . 6 Pengguna memilih perintah Sembunyikan Nama Karakter . 7 Pengguna memilih (mengklik) karakter.

Keterangan

Biasanya, mode Bantuan selesai saat pengguna mengklik atau menyeret karakter atau memilih perintah dari menu pop-up karakter. Mengklik karakter lain atau di tempat lain pada layar tidak membatalkan mode Bantuan. Klien yang mengatur mode Bantuan untuk karakter dapat membatalkan mode Bantuan dengan mengatur HelpModeOn ke False. (Ini tidak memicu peristiwa HelpComplete .)

Saat pengguna memilih perintah dari menu pop-up karakter dalam mode Bantuan, server menghapus menu, memanggil Bantuan dengan HelpContextID yang ditentukan perintah, dan mengirim kejadian ini. Peka konteks (juga dikenal sebagai Apa Ini?) Jendela bantuan ditampilkan di lokasi penunjuk. Jika pengguna memilih perintah berdasarkan input suara, jendela Bantuan ditampilkan di atas karakter. Jika karakter di luar layar, jendela ditampilkan di layar terdekat dengan posisi karakter saat ini.

Jika server mengembalikan Nama sebagai string kosong (""), itu menunjukkan bahwa pengguna memilih perintah yang disediakan server.

Kejadian ini hanya dikirim ke aplikasi klien yang menempatkan karakter dalam mode Bantuan.

Lihat juga

Properti HelpModeOn, properti HelpContextID