IAxWinAmbientDispatch Interface

Opmerking

De ATL (Active Template Library) wordt nog steeds ondersteund. We voegen echter geen functies meer toe of werken de documentatie bij.

Deze interface biedt methoden voor het opgeven van kenmerken van het gehoste besturingselement of de container.

Belangrijk

Deze klasse en de bijbehorende leden kunnen niet worden gebruikt in toepassingen die worden uitgevoerd in Windows Runtime.

Syntaxis

interface IAxWinAmbientDispatch : IDispatch

Leden

Methods

Naam	Description
get_AllowContextMenu	De AllowContextMenu eigenschap geeft aan of het gehoste besturingselement een eigen contextmenu mag weergeven.
get_AllowShowUI	De AllowShowUI eigenschap geeft aan of het gehoste besturingselement een eigen gebruikersinterface mag weergeven.
get_AllowWindowlessActivation	De AllowWindowlessActivation eigenschap geeft aan of de container vensterloze activering toestaat.
get_BackColor	De BackColor eigenschap geeft de achtergrondkleur van de omgeving van de container op.
get_DisplayAsDefault	DisplayAsDefault is een omgevingseigenschap waarmee een besturingselement kan achterhalen of dit het standaardbesturingselement is.
get_DocHostDoubleClickFlags	De DocHostDoubleClickFlags eigenschap geeft de bewerking op die moet worden uitgevoerd als reactie op een dubbelklik.
get_DocHostFlags	De DocHostFlags eigenschap geeft de gebruikersinterfacemogelijkheden van het hostobject op.
get_Font	De Font eigenschap geeft het omgevingslettertype van de container op.
get_ForeColor	De ForeColor eigenschap geeft de omgevingskleur van de container op.
get_LocaleID	De LocaleID eigenschap geeft de omgevingsinstellings-id van de container op.
get_MessageReflect	De MessageReflect omgevingseigenschap geeft aan of de container berichten weergeeft aan het gehoste besturingselement.
get_OptionKeyPath	De OptionKeyPath eigenschap geeft het pad naar de registersleutel op naar gebruikersinstellingen.
get_ShowGrabHandles	Met ShowGrabHandles de omgevingseigenschap kan het besturingselement erachter komen of het zichzelf met greepgrepen moet tekenen.
get_ShowHatching	Met ShowHatching de omgevingseigenschap kan de besturing achterhalen of het zelf moet worden uitgebroed.
get_UserMode	De UserMode eigenschap geeft de omgevingsgebruikersmodus van de container op.
put_AllowContextMenu	De AllowContextMenu eigenschap geeft aan of het gehoste besturingselement een eigen contextmenu mag weergeven.
put_AllowShowUI	De AllowShowUI eigenschap geeft aan of het gehoste besturingselement een eigen gebruikersinterface mag weergeven.
put_AllowWindowlessActivation	De AllowWindowlessActivation eigenschap geeft aan of de container vensterloze activering toestaat.
put_BackColor	De BackColor eigenschap geeft de achtergrondkleur van de omgeving van de container op.
put_DisplayAsDefault	DisplayAsDefault is een omgevingseigenschap waarmee een besturingselement kan achterhalen of dit het standaardbesturingselement is.
put_DocHostDoubleClickFlags	De DocHostDoubleClickFlags eigenschap geeft de bewerking op die moet worden uitgevoerd als reactie op een dubbelklik.
put_DocHostFlags	De DocHostFlags eigenschap geeft de gebruikersinterfacemogelijkheden van het hostobject op.
put_Font	De Font eigenschap geeft het omgevingslettertype van de container op.
put_ForeColor	De ForeColor eigenschap geeft de omgevingskleur van de container op.
put_LocaleID	De LocaleID eigenschap geeft de omgevingsinstellings-id van de container op.
put_MessageReflect	De MessageReflect omgevingseigenschap geeft aan of de container berichten weergeeft aan het gehoste besturingselement.
put_OptionKeyPath	De OptionKeyPath eigenschap geeft het pad naar de registersleutel op naar gebruikersinstellingen.
put_UserMode	De UserMode eigenschap geeft de omgevingsgebruikersmodus van de container op.

Opmerkingen

Deze interface wordt weergegeven door het ActiveX-besturingselement van ATL dat als host fungeert voor objecten. Roep de methoden op deze interface aan om de omgevingseigenschappen in te stellen die beschikbaar zijn voor het gehoste besturingselement of om andere aspecten van het gedrag van de container op te geven. Gebruik IAxWinAmbientDispatchEx als aanvulling op de eigenschappen die worden IAxWinAmbientDispatchverstrekt.

AxHost probeert typegegevens te laden over IAxWinAmbientDispatch en IAxWinAmbientDispatchEx uit de typelib die de code bevat.

Als u een koppeling naar ATL90.dll, laadt AXHost de typegegevens uit de typelib in het DLL-bestand.

Zie ActiveX-besturingselementen hosten met ATL AXHost voor meer informatie.

Requirements

De definitie van deze interface is beschikbaar in een aantal formulieren, zoals wordt weergegeven in de onderstaande tabel.

Definitietype	Bestand
IDL	atliface.idl
Type bibliotheek	ATL.dll
C++	atliface.h (ook opgenomen in ATLBase.h)

IAxWinAmbientDispatch::get_AllowContextMenu

De AllowContextMenu eigenschap geeft aan of het gehoste besturingselement een eigen contextmenu mag weergeven.

STDMETHOD(get_AllowContextMenu)(VARIANT_BOOL* pbAllowContextMenu);

Parameterwaarden

pbAllowContextMenu
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt VARIANT_TRUE als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::get_AllowShowUI

De AllowShowUI eigenschap geeft aan of het gehoste besturingselement een eigen gebruikersinterface mag weergeven.

STDMETHOD(get_AllowShowUI)(VARIANT_BOOL* pbAllowShowUI);

Parameterwaarden

pbAllowShowUI
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van VARIANT_FALSE als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::get_AllowWindowlessActivation

De AllowWindowlessActivation eigenschap geeft aan of de container vensterloze activering toestaat.

STDMETHOD(get_AllowWindowlessActivation)(VARIANT_BOOL* pbAllowWindowless);

Parameterwaarden

pbAllowWindowless
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt VARIANT_TRUE als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::get_BackColor

De BackColor eigenschap geeft de achtergrondkleur van de omgeving van de container op.

STDMETHOD(get_BackColor)(OLE_COLOR* pclrBackground);

Parameterwaarden

pclrBackground
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van COLOR_BTNFACE of COLOR_WINDOW als de standaardwaarde van deze eigenschap (afhankelijk van of het bovenliggende hostvenster een dialoogvenster is of niet).

IAxWinAmbientDispatch::get_DisplayAsDefault

DisplayAsDefault is een omgevingseigenschap waarmee een besturingselement kan achterhalen of dit het standaardbesturingselement is.

STDMETHOD(get_DisplayAsDefault)(VARIANT_BOOL* pbDisplayAsDefault);

Parameterwaarden

pbDisplayAsDefault
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van VARIANT_FALSE als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::get_DocHostDoubleClickFlags

De DocHostDoubleClickFlags eigenschap geeft de bewerking op die moet worden uitgevoerd als reactie op een dubbelklik.

STDMETHOD(get_DocHostDoubleClickFlags)(DWORD* pdwDocHostDoubleClickFlags);

Parameterwaarden

pdwDocHostDoubleClickFlags
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van DOCHOSTUIDBLCLK_DEFAULT als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::get_DocHostFlags

De DocHostFlags eigenschap geeft de gebruikersinterfacemogelijkheden van het hostobject op.

STDMETHOD(get_DocHostFlags)(DWORD* pdwDocHostFlags);

Parameterwaarden

pdwDocHostFlags
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt DOCHOSTUIFLAG_NO3DBORDER als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::get_Font

De Font eigenschap geeft het omgevingslettertype van de container op.

STDMETHOD(get_Font)(IFontDisp** pFont);

Parameterwaarden

pFont
[uit] Het adres van een IFontDisp interfaceaanwijzer die wordt gebruikt om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van het standaard-GUI-lettertype of het systeemlettertype als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::get_ForeColor

De ForeColor eigenschap geeft de omgevingskleur van de container op.

STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);

Parameterwaarden

pclrForeground
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt de tekstkleur van het systeemvenster als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::get_LocaleID

De LocaleID eigenschap geeft de omgevingsinstellings-id van de container op.

STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);

Parameterwaarden

plcidLocaleID
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van de standaardlandinstelling van de gebruiker als de standaardwaarde van deze eigenschap.

Met deze methode kunt u de Omgevings localID ontdekken, dat wil gezegd, de LocaleID van het programma waarin uw controle wordt gebruikt. Zodra u de LocaleID kent, kunt u code aanroepen om landinstellingenspecifieke bijschriften te laden, tekst van foutberichten, enzovoort vanuit een bronbestand of satelliet-DLL.

IAxWinAmbientDispatch::get_MessageReflect

De MessageReflect omgevingseigenschap geeft aan of de container berichten weergeeft aan het gehoste besturingselement.

STDMETHOD(get_MessageReflect)(VARIANT_BOOL* pbMessageReflect);

Parameterwaarden

pbMessageReflect
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt VARIANT_TRUE als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::get_OptionKeyPath

De OptionKeyPath eigenschap geeft het pad naar de registersleutel op naar gebruikersinstellingen.

STDMETHOD(get_OptionKeyPath)(BSTR* pbstrOptionKeyPath);

Parameterwaarden

pbstrOptionKeyPath
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

IAxWinAmbientDispatch::get_ShowGrabHandles

Met ShowGrabHandles de omgevingseigenschap kan het besturingselement erachter komen of het zichzelf met greepgrepen moet tekenen.

STDMETHOD(get_ShowGrabHandles)(VARIANT_BOOL* pbShowGrabHandles);

Parameterwaarden

pbShowGrabHandles
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject retourneert altijd VARIANT_FALSE als de waarde van deze eigenschap.

IAxWinAmbientDispatch::get_ShowHatching

Met ShowHatching de omgevingseigenschap kan de besturing achterhalen of het zelf moet worden uitgebroed.

STDMETHOD(get_ShowHatching)(VARIANT_BOOL* pbShowHatching);

Parameterwaarden

pbShowHatching
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject retourneert altijd VARIANT_FALSE als de waarde van deze eigenschap.

IAxWinAmbientDispatch::get_UserMode

De UserMode eigenschap geeft de omgevingsgebruikersmodus van de container op.

STDMETHOD(get_UserMode)(VARIANT_BOOL* pbUserMode);

Parameterwaarden

pbUserMode
[uit] Het adres van een variabele om de huidige waarde van deze eigenschap te ontvangen.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt VARIANT_TRUE als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::p ut_AllowContextMenu

De AllowContextMenu eigenschap geeft aan of het gehoste besturingselement een eigen contextmenu mag weergeven.

STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);

Parameterwaarden

bAllowContextMenu
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt VARIANT_TRUE als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::p ut_AllowShowUI

De AllowShowUI eigenschap geeft aan of het gehoste besturingselement een eigen gebruikersinterface mag weergeven.

STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);

Parameterwaarden

bAllowShowUI
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van VARIANT_FALSE als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::p ut_AllowWindowlessActivation

De AllowWindowlessActivation eigenschap geeft aan of de container vensterloze activering toestaat.

STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);

Parameterwaarden

bAllowWindowless
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt VARIANT_TRUE als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::p ut_BackColor

De BackColor eigenschap geeft de achtergrondkleur van de omgeving van de container op.

STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);

Parameterwaarden

clrBackground
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van COLOR_BTNFACE of COLOR_WINDOW als de standaardwaarde van deze eigenschap (afhankelijk van of het bovenliggende hostvenster een dialoogvenster is of niet).

IAxWinAmbientDispatch::p ut_DisplayAsDefault

DisplayAsDefault is een omgevingseigenschap waarmee een besturingselement kan achterhalen of dit het standaardbesturingselement is.

STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);

Parameterwaarden

bDisplayAsDefault
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van VARIANT_FALSE als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::p ut_DocHostDoubleClickFlags

De DocHostDoubleClickFlags eigenschap geeft de bewerking op die moet worden uitgevoerd als reactie op een dubbelklik.

STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);

Parameterwaarden

dwDocHostDoubleClickFlags
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van DOCHOSTUIDBLCLK_DEFAULT als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::p ut_DocHostFlags

De DocHostFlags eigenschap geeft de gebruikersinterfacemogelijkheden van het hostobject op.

STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);

Parameterwaarden

dwDocHostFlags
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt DOCHOSTUIFLAG_NO3DBORDER als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::p ut_Font

De Font eigenschap geeft het omgevingslettertype van de container op.

STDMETHOD(put_Font)(IFontDisp* pFont);

Parameterwaarden

pFont
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van het standaard-GUI-lettertype of het systeemlettertype als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::p ut_ForeColor

De ForeColor eigenschap geeft de omgevingskleur van de container op.

STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);

Parameterwaarden

clrForeground
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt de tekstkleur van het systeemvenster als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::p ut_LocaleID

De LocaleID eigenschap geeft de omgevingsinstellings-id van de container op.

STDMETHOD(put_LocaleID)(LCID lcidLocaleID);

Parameterwaarden

lcidLocaleID
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject maakt gebruik van de standaardlandinstelling van de gebruiker als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::p ut_MessageReflect

De MessageReflect omgevingseigenschap geeft aan of de container berichten weergeeft aan het gehoste besturingselement.

STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);

Parameterwaarden

bMessageReflect
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt VARIANT_TRUE als de standaardwaarde van deze eigenschap.

IAxWinAmbientDispatch::p ut_OptionKeyPath

De OptionKeyPath eigenschap geeft het pad naar de registersleutel op naar gebruikersinstellingen.

STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);

Parameterwaarden

bstrOptionKeyPath
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

IAxWinAmbientDispatch::p ut_UserMode

De UserMode eigenschap geeft de omgevingsgebruikersmodus van de container op.

STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);

Parameterwaarden

bUserMode
[in] De nieuwe waarde van deze eigenschap.

Retourwaarde

Een standaard HRESULT-waarde.

Opmerkingen

De implementatie van het ATL-hostobject gebruikt VARIANT_TRUE als de standaardwaarde van deze eigenschap.

Zie ook

IAxWinAmbientDispatchEx Interface
IAxWinHostWindow Interface
CAxWindow::QueryHost
AtlAxGetHost