Antarmuka IAxWinAmbientDispatch

Antarmuka ini menyediakan metode untuk menentukan karakteristik kontrol atau kontainer yang dihosting.

Penting

Kelas ini dan anggotanya tidak dapat digunakan dalam aplikasi yang dijalankan di Windows Runtime.

Sintaks

interface IAxWinAmbientDispatch : IDispatch

Anggota

Metode

Nama	Deskripsi
get_AllowContextMenu	Properti AllowContextMenu menentukan apakah kontrol yang dihosting diizinkan untuk menampilkan menu konteksnya sendiri.
get_AllowShowUI	Properti AllowShowUI menentukan apakah kontrol yang dihosting diizinkan untuk menampilkan antarmuka penggunanya sendiri.
get_AllowWindowlessActivation	Properti AllowWindowlessActivation menentukan apakah kontainer akan mengizinkan aktivasi tanpa jendela.
get_BackColor	Properti BackColor menentukan warna latar belakang sekitar kontainer.
get_DisplayAsDefault	DisplayAsDefault adalah properti sekitar yang memungkinkan kontrol untuk mencari tahu apakah itu adalah kontrol default.
get_DocHostDoubleClickFlags	Properti DocHostDoubleClickFlags menentukan operasi yang harus dilakukan sebagai respons terhadap klik dua kali.
get_DocHostFlags	Properti DocHostFlags menentukan kemampuan antarmuka pengguna dari objek host.
get_Font	Properti Font menentukan font sekitar kontainer.
get_ForeColor	Properti ForeColor menentukan warna latar depan sekitar kontainer.
get_LocaleID	Properti LocaleID menentukan ID lokal sekitar kontainer.
get_MessageReflect	Properti MessageReflect sekitar menentukan apakah kontainer akan mencerminkan pesan ke kontrol yang dihosting.
get_OptionKeyPath	Properti OptionKeyPath menentukan jalur kunci registri ke pengaturan pengguna.
get_ShowGrabHandles	Properti ShowGrabHandles sekitar memungkinkan kontrol untuk mencari tahu apakah properti harus menggambar dirinya sendiri dengan handel ambil.
get_ShowHatching	Properti ShowHatching sekitar memungkinkan kontrol untuk mencari tahu apakah properti harus menetas dengan sendirinya.
get_UserMode	Properti UserMode menentukan mode pengguna sekitar kontainer.
put_AllowContextMenu	Properti AllowContextMenu menentukan apakah kontrol yang dihosting diizinkan untuk menampilkan menu konteksnya sendiri.
put_AllowShowUI	Properti AllowShowUI menentukan apakah kontrol yang dihosting diizinkan untuk menampilkan antarmuka penggunanya sendiri.
put_AllowWindowlessActivation	Properti AllowWindowlessActivation menentukan apakah kontainer akan mengizinkan aktivasi tanpa jendela.
put_BackColor	Properti BackColor menentukan warna latar belakang sekitar kontainer.
put_DisplayAsDefault	DisplayAsDefault adalah properti sekitar yang memungkinkan kontrol untuk mencari tahu apakah itu adalah kontrol default.
put_DocHostDoubleClickFlags	Properti DocHostDoubleClickFlags menentukan operasi yang harus dilakukan sebagai respons terhadap klik dua kali.
put_DocHostFlags	Properti DocHostFlags menentukan kemampuan antarmuka pengguna dari objek host.
put_Font	Properti Font menentukan font sekitar kontainer.
put_ForeColor	Properti ForeColor menentukan warna latar depan sekitar kontainer.
put_LocaleID	Properti LocaleID menentukan ID lokal sekitar kontainer.
put_MessageReflect	Properti MessageReflect sekitar menentukan apakah kontainer akan mencerminkan pesan ke kontrol yang dihosting.
put_OptionKeyPath	Properti OptionKeyPath menentukan jalur kunci registri ke pengaturan pengguna.
put_UserMode	Properti UserMode menentukan mode pengguna sekitar kontainer.

Keterangan

Antarmuka ini diekspos oleh objek hosting kontrol ActiveX ATL. Panggil metode pada antarmuka ini untuk mengatur properti sekitar yang tersedia untuk kontrol yang dihosting atau untuk menentukan aspek lain dari perilaku kontainer. Untuk melengkapi properti yang disediakan oleh IAxWinAmbientDispatch, gunakan IAxWinAmbientDispatchEx.

AxHost akan mencoba memuat informasi jenis tentang IAxWinAmbientDispatch dan IAxWinAmbientDispatchEx dari typelib yang berisi kode.

Jika Anda menautkan ke ATL90.dll, AXHost akan memuat informasi jenis dari typelib di DLL.

Lihat Menghosting Kontrol ActiveX Menggunakan ATL AXHost untuk detail selengkapnya.

Persyaratan

Definisi antarmuka ini tersedia dalam sejumlah formulir, seperti yang ditunjukkan pada tabel di bawah ini.

Tipe Definisi	File
IDL	atliface.idl
Tipe Pustaka	ATL.dll
C++	atliface.h (juga termasuk dalam ATLBase.h)

IAxWinAmbientDispatch::get_AllowContextMenu

Properti AllowContextMenu menentukan apakah kontrol yang dihosting diizinkan untuk menampilkan menu konteksnya sendiri.

STDMETHOD(get_AllowContextMenu)(VARIANT_BOOL* pbAllowContextMenu);

Parameter

pbAllowContextMenu
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_TRUE sebagai nilai default properti ini.

IAxWinAmbientDispatch::get_AllowShowUI

Properti AllowShowUI menentukan apakah kontrol yang dihosting diizinkan untuk menampilkan antarmuka penggunanya sendiri.

STDMETHOD(get_AllowShowUI)(VARIANT_BOOL* pbAllowShowUI);

Parameter

pbAllowShowUI
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_FALSE sebagai nilai default properti ini.

IAxWinAmbientDispatch::get_AllowWindowlessActivation

Properti AllowWindowlessActivation menentukan apakah kontainer akan mengizinkan aktivasi tanpa jendela.

STDMETHOD(get_AllowWindowlessActivation)(VARIANT_BOOL* pbAllowWindowless);

Parameter

pbAllowWindowless
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_TRUE sebagai nilai default properti ini.

IAxWinAmbientDispatch::get_BackColor

Properti BackColor menentukan warna latar belakang sekitar kontainer.

STDMETHOD(get_BackColor)(OLE_COLOR* pclrBackground);

Parameter

pclrBackground
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan COLOR_BTNFACE atau COLOR_WINDOW sebagai nilai default properti ini (tergantung pada apakah induk jendela host adalah dialog atau tidak).

IAxWinAmbientDispatch::get_DisplayAsDefault

DisplayAsDefault adalah properti sekitar yang memungkinkan kontrol untuk mencari tahu apakah itu adalah kontrol default.

STDMETHOD(get_DisplayAsDefault)(VARIANT_BOOL* pbDisplayAsDefault);

Parameter

pbDisplayAsDefault
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_FALSE sebagai nilai default properti ini.

IAxWinAmbientDispatch::get_DocHostDoubleClickFlags

Properti DocHostDoubleClickFlags menentukan operasi yang harus dilakukan sebagai respons terhadap klik dua kali.

STDMETHOD(get_DocHostDoubleClickFlags)(DWORD* pdwDocHostDoubleClickFlags);

Parameter

pdwDocHostDoubleClickFlags
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan DOCHOSTUIDBLCLK_DEFAULT sebagai nilai default properti ini.

IAxWinAmbientDispatch::get_DocHostFlags

Properti DocHostFlags menentukan kemampuan antarmuka pengguna dari objek host.

STDMETHOD(get_DocHostFlags)(DWORD* pdwDocHostFlags);

Parameter

pdwDocHostFlags
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan DOCHOSTUIFLAG_NO3DBORDER sebagai nilai default properti ini.

IAxWinAmbientDispatch::get_Font

Properti Font menentukan font sekitar kontainer.

STDMETHOD(get_Font)(IFontDisp** pFont);

Parameter

pFont
[out] Alamat penunjuk antarmuka yang IFontDisp digunakan untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan font GUI default atau font sistem sebagai nilai default properti ini.

IAxWinAmbientDispatch::get_ForeColor

Properti ForeColor menentukan warna latar depan sekitar kontainer.

STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);

Parameter

pclrForeground
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan warna teks jendela sistem sebagai nilai default properti ini.

IAxWinAmbientDispatch::get_LocaleID

Properti LocaleID menentukan ID lokal sekitar kontainer.

STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);

Parameter

plcidLocaleID
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan lokal default pengguna sebagai nilai default properti ini.

Dengan metode ini Anda dapat menemukan Ambient LocalID, yaitu LocaleID program tempat kontrol Anda digunakan. Setelah Mengetahui LocaleID, Anda dapat memanggil kode untuk memuat keterangan khusus lokal, teks pesan kesalahan, dan sebagainya dari file sumber daya atau DLL satelit.

IAxWinAmbientDispatch::get_MessageReflect

Properti MessageReflect sekitar menentukan apakah kontainer akan mencerminkan pesan ke kontrol yang dihosting.

STDMETHOD(get_MessageReflect)(VARIANT_BOOL* pbMessageReflect);

Parameter

pbMessageReflect
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_TRUE sebagai nilai default properti ini.

IAxWinAmbientDispatch::get_OptionKeyPath

Properti OptionKeyPath menentukan jalur kunci registri ke pengaturan pengguna.

STDMETHOD(get_OptionKeyPath)(BSTR* pbstrOptionKeyPath);

Parameter

pbstrOptionKeyPath
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

IAxWinAmbientDispatch::get_ShowGrabHandles

Properti ShowGrabHandles sekitar memungkinkan kontrol untuk mencari tahu apakah properti harus menggambar dirinya sendiri dengan handel ambil.

STDMETHOD(get_ShowGrabHandles)(VARIANT_BOOL* pbShowGrabHandles);

Parameter

pbShowGrabHandles
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL selalu mengembalikan VARIANT_FALSE sebagai nilai properti ini.

IAxWinAmbientDispatch::get_ShowHatching

Properti ShowHatching sekitar memungkinkan kontrol untuk mencari tahu apakah properti harus menetas dengan sendirinya.

STDMETHOD(get_ShowHatching)(VARIANT_BOOL* pbShowHatching);

Parameter

pbShowHatching
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL selalu mengembalikan VARIANT_FALSE sebagai nilai properti ini.

IAxWinAmbientDispatch::get_UserMode

Properti UserMode menentukan mode pengguna sekitar kontainer.

STDMETHOD(get_UserMode)(VARIANT_BOOL* pbUserMode);

Parameter

pbUserMode
[out] Alamat variabel untuk menerima nilai properti ini saat ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_TRUE sebagai nilai default properti ini.

IAxWinAmbientDispatch::p ut_AllowContextMenu

Properti AllowContextMenu menentukan apakah kontrol yang dihosting diizinkan untuk menampilkan menu konteksnya sendiri.

STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);

Parameter

bAllowContextMenu
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_TRUE sebagai nilai default properti ini.

IAxWinAmbientDispatch::p ut_AllowShowUI

Properti AllowShowUI menentukan apakah kontrol yang dihosting diizinkan untuk menampilkan antarmuka penggunanya sendiri.

STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);

Parameter

bAllowShowUI
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_FALSE sebagai nilai default properti ini.

IAxWinAmbientDispatch::p ut_AllowWindowlessActivation

Properti AllowWindowlessActivation menentukan apakah kontainer akan mengizinkan aktivasi tanpa jendela.

STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);

Parameter

bAllowWindowless
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_TRUE sebagai nilai default properti ini.

IAxWinAmbientDispatch::p ut_BackColor

Properti BackColor menentukan warna latar belakang sekitar kontainer.

STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);

Parameter

clrBackground
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan COLOR_BTNFACE atau COLOR_WINDOW sebagai nilai default properti ini (tergantung pada apakah induk jendela host adalah dialog atau tidak).

IAxWinAmbientDispatch::p ut_DisplayAsDefault

DisplayAsDefault adalah properti sekitar yang memungkinkan kontrol untuk mencari tahu apakah itu adalah kontrol default.

STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);

Parameter

bDisplayAsDefault
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_FALSE sebagai nilai default properti ini.

IAxWinAmbientDispatch::p ut_DocHostDoubleClickFlags

Properti DocHostDoubleClickFlags menentukan operasi yang harus dilakukan sebagai respons terhadap klik dua kali.

STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);

Parameter

dwDocHostDoubleClickFlags
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan DOCHOSTUIDBLCLK_DEFAULT sebagai nilai default properti ini.

IAxWinAmbientDispatch::p ut_DocHostFlags

Properti DocHostFlags menentukan kemampuan antarmuka pengguna dari objek host.

STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);

Parameter

dwDocHostFlags
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan DOCHOSTUIFLAG_NO3DBORDER sebagai nilai default properti ini.

IAxWinAmbientDispatch::p ut_Font

Properti Font menentukan font sekitar kontainer.

STDMETHOD(put_Font)(IFontDisp* pFont);

Parameter

pFont
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan font GUI default atau font sistem sebagai nilai default properti ini.

IAxWinAmbientDispatch::p ut_ForeColor

Properti ForeColor menentukan warna latar depan sekitar kontainer.

STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);

Parameter

clrForeground
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan warna teks jendela sistem sebagai nilai default properti ini.

IAxWinAmbientDispatch::p ut_LocaleID

Properti LocaleID menentukan ID lokal sekitar kontainer.

STDMETHOD(put_LocaleID)(LCID lcidLocaleID);

Parameter

lcidLocaleID
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan lokal default pengguna sebagai nilai default properti ini.

IAxWinAmbientDispatch::p ut_MessageReflect

Properti MessageReflect sekitar menentukan apakah kontainer akan mencerminkan pesan ke kontrol yang dihosting.

STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);

Parameter

bMessageReflect
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_TRUE sebagai nilai default properti ini.

IAxWinAmbientDispatch::p ut_OptionKeyPath

Properti OptionKeyPath menentukan jalur kunci registri ke pengaturan pengguna.

STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);

Parameter

bstrOptionKeyPath
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

IAxWinAmbientDispatch::p ut_UserMode

Properti UserMode menentukan mode pengguna sekitar kontainer.

STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);

Parameter

bUserMode
[di] Nilai baru properti ini.

Tampilkan Nilai

Nilai HRESULT standar.

Keterangan

Implementasi objek host ATL menggunakan VARIANT_TRUE sebagai nilai default properti ini.

Lihat juga

Antarmuka IAxWinAmbientDispatchEx
Antarmuka IAxWinHostWindow
CAxWindow::QueryHost
AtlAxGetHost