Bagikan melalui

Metode IOleWindow::ContextSensitiveHelp (oleidl.h)

  • Artikel

Menentukan apakah mode bantuan peka konteks harus dimasukkan selama sesi aktivasi di tempat.

Sintaks

HRESULT ContextSensitiveHelp(
  [in] BOOL fEnterMode
);

Parameter

[in] fEnterMode

TRUE jika mode bantuan harus dimasukkan; FALSE jika harus keluar.

Nilai kembali

Metode ini mengembalikan S_OK jika mode bantuan berhasil dimasukkan atau keluar, tergantung pada nilai yang diteruskan dalam fEnterMode. Nilai pengembalian lain yang mungkin termasuk yang berikut ini.

Menampilkan kode Deskripsi
E_INVALIDARG
 Nilai fEnterMode yang ditentukan tidak valid.
E_OUTOFMEMORY
 Tidak tersedia cukup memori untuk operasi ini.
E_UNEXPECTED
 Terjadi kesalahan tidak terduga.

Keterangan

Aplikasi dapat memanggil bantuan peka konteks saat pengguna:

  • menekan SHIFT+F1, lalu mengklik topik
  • menekan F1 saat item menu dipilih
Ketika SHIFT+F1 ditekan, bingkai atau objek aktif dapat menerima penekanan tombol. Jika bingkai kontainer menerima penekanan tombol, bingkai memanggil metode IOleWindow::ContextSensitiveHelp dokumen yang berisi dengan fEnterMode diatur ke TRUE. Ini menyebarkan status bantuan ke semua objek di tempatnya sehingga mereka dapat menangani klik mouse atau WM_COMMAND dengan benar.

Jika objek aktif menerima penekanan tombol SHIFT+F1, objek ini memanggil metode IOleWindow::ContextSensitiveHelp kontainer dengan fEnterModeTRUE, yang kemudian secara rekursif memanggil setiap situs di tempatnya sampai tidak ada lagi yang akan diberi tahu. Kontainer kemudian memanggil metode IOleWindow::ContextSensitiveHelp dokumen atau bingkainya dengan fEnterModeTRUE.

Saat dalam mode bantuan sensitif konteks, objek yang menerima klik mouse dapat:

  • Abaikan klik jika tidak mendukung bantuan peka konteks.
  • Beri tahu semua objek lain untuk keluar dari mode bantuan sensitif konteks dengan ContextSensitiveHelp diatur ke FALSE lalu berikan bantuan untuk konteks tersebut.
Objek dalam mode bantuan sensitif konteks yang menerima WM_COMMAND harus memberi tahu semua objek di tempat lainnya untuk keluar dari mode bantuan sensitif konteks lalu memberikan bantuan untuk perintah.

Jika aplikasi kontainer mendukung bantuan sensitif konteks pada item menu, aplikasi tersebut harus menyediakan filter pesannya sendiri sehingga dapat mencegat kunci F1 atau meminta pustaka OLE untuk menambahkan filter pesan dengan memanggil OleSetMenuDescriptor, meneruskan nilai non-NULL yang valid untuk parameter lpFrame dan lpActiveObj .

Persyaratan

Persyaratan Nilai
Klien minimum yang didukung Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung Windows 2000 Server [hanya aplikasi desktop]
Target Platform Windows
Header oleidl.h

Lihat juga

IOleWindow

OleSetMenuDescriptor