IAxWinAmbientDispatch-Schnittstelle

Diese Schnittstelle stellt Methoden zum Angeben von Merkmalen des gehosteten Steuerelements oder Containers bereit.

Wichtig

Diese Klasse und ihre Member können nicht in Anwendungen verwendet werden, die in der Windows-Runtime ausgeführt werden.

Syntax

interface IAxWinAmbientDispatch : IDispatch

Member

Methoden

Name	Beschreibung
get_AllowContextMenu	Die AllowContextMenu Eigenschaft gibt an, ob das gehostete Steuerelement sein eigenes Kontextmenü anzeigen darf.
get_AllowShowUI	Die AllowShowUI Eigenschaft gibt an, ob das gehostete Steuerelement seine eigene Benutzeroberfläche anzeigen darf.
get_AllowWindowlessActivation	Die AllowWindowlessActivation Eigenschaft gibt an, ob der Container eine fensterlose Aktivierung zulässt.
get_BackColor	Die BackColor Eigenschaft gibt die Umgebungshintergrundfarbe des Containers an.
get_DisplayAsDefault	DisplayAsDefault ist eine Umgebungseigenschaft, mit der ein Steuerelement herausfinden kann, ob es sich um das Standardsteuerelement handelt.
get_DocHostDoubleClickFlags	Die DocHostDoubleClickFlags Eigenschaft gibt den Vorgang an, der als Reaktion auf einen Doppelklick ausgeführt werden soll.
get_DocHostFlags	Die DocHostFlags Eigenschaft gibt die Benutzeroberflächenfunktionen des Hostobjekts an.
get_Font	Die Font Eigenschaft gibt die Umgebungsschriftart des Containers an.
get_ForeColor	Die ForeColor Eigenschaft gibt die Umgebungs-Vordergrundfarbe des Containers an.
get_LocaleID	Die LocaleID Eigenschaft gibt die Umgebungsgebietsschema-ID des Containers an.
get_MessageReflect	Die MessageReflect Umgebungseigenschaft gibt an, ob der Container Nachrichten an das gehostete Steuerelement widerspiegelt.
get_OptionKeyPath	Die OptionKeyPath Eigenschaft gibt den Registrierungsschlüsselpfad zu Den Benutzereinstellungen an.
get_ShowGrabHandles	Mit ShowGrabHandles der Umgebungseigenschaft kann das Steuerelement herausfinden, ob es sich selbst mit Ziehpunkten zeichnen soll.
get_ShowHatching	Die ShowHatching Umgebungseigenschaft ermöglicht es dem Steuerelement herauszufinden, ob es sich selbst geschlüpft zeichnen soll.
get_UserMode	Die UserMode Eigenschaft gibt den Umgebungsbenutzermodus des Containers an.
put_AllowContextMenu	Die AllowContextMenu Eigenschaft gibt an, ob das gehostete Steuerelement sein eigenes Kontextmenü anzeigen darf.
put_AllowShowUI	Die AllowShowUI Eigenschaft gibt an, ob das gehostete Steuerelement seine eigene Benutzeroberfläche anzeigen darf.
put_AllowWindowlessActivation	Die AllowWindowlessActivation Eigenschaft gibt an, ob der Container eine fensterlose Aktivierung zulässt.
put_BackColor	Die BackColor Eigenschaft gibt die Umgebungshintergrundfarbe des Containers an.
put_DisplayAsDefault	DisplayAsDefault ist eine Umgebungseigenschaft, mit der ein Steuerelement herausfinden kann, ob es sich um das Standardsteuerelement handelt.
put_DocHostDoubleClickFlags	Die DocHostDoubleClickFlags Eigenschaft gibt den Vorgang an, der als Reaktion auf einen Doppelklick ausgeführt werden soll.
put_DocHostFlags	Die DocHostFlags Eigenschaft gibt die Benutzeroberflächenfunktionen des Hostobjekts an.
put_Font	Die Font Eigenschaft gibt die Umgebungsschriftart des Containers an.
put_ForeColor	Die ForeColor Eigenschaft gibt die Umgebungs-Vordergrundfarbe des Containers an.
put_LocaleID	Die LocaleID Eigenschaft gibt die Umgebungsgebietsschema-ID des Containers an.
put_MessageReflect	Die MessageReflect Umgebungseigenschaft gibt an, ob der Container Nachrichten an das gehostete Steuerelement widerspiegelt.
put_OptionKeyPath	Die OptionKeyPath Eigenschaft gibt den Registrierungsschlüsselpfad zu Den Benutzereinstellungen an.
put_UserMode	Die UserMode Eigenschaft gibt den Umgebungsbenutzermodus des Containers an.

Hinweise

Diese Schnittstelle wird durch das Hostobjekt des ActiveX-Steuerelements von ATL verfügbar gemacht. Rufen Sie die Methoden auf dieser Schnittstelle auf, um die Umgebungseigenschaften festzulegen, die für das gehostete Steuerelement verfügbar sind, oder um andere Aspekte des Verhaltens des Containers anzugeben. Verwenden Sie IAxWinAmbientDispatchEx, um die von ihnen bereitgestellten IAxWinAmbientDispatchEigenschaften zu ergänzen.

AxHost versucht, Typinformationen zu IAxWinAmbientDispatch und IAxWinAmbientDispatchEx aus der Typelib zu laden, die den Code enthält.

Wenn Sie eine Verknüpfung mit ATL90.dll herstellen, lädt AXHost die Typinformationen aus der Typelib in der DLL.

Weitere Informationen finden Sie unter Hosten von ActiveX-Steuerelementen mit ATL AXHost .

Anforderungen

Die Definition dieser Schnittstelle ist in einer Reihe von Formularen verfügbar, wie in der folgenden Tabelle dargestellt.

Definitionstyp	Datei
IDL	atliface.idl
Typbibliothek	ATL.dll
C++	atliface.h (auch in ATLBase.h enthalten)

IAxWinAmbientDispatch::get_AllowContextMenu

Die AllowContextMenu Eigenschaft gibt an, ob das gehostete Steuerelement sein eigenes Kontextmenü anzeigen darf.

STDMETHOD(get_AllowContextMenu)(VARIANT_BOOL* pbAllowContextMenu);

Parameter

pbAllowContextMenu
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_TRUE als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::get_AllowShowUI

Die AllowShowUI Eigenschaft gibt an, ob das gehostete Steuerelement seine eigene Benutzeroberfläche anzeigen darf.

STDMETHOD(get_AllowShowUI)(VARIANT_BOOL* pbAllowShowUI);

Parameter

pbAllowShowUI
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_FALSE als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::get_AllowWindowlessActivation

Die AllowWindowlessActivation Eigenschaft gibt an, ob der Container eine fensterlose Aktivierung zulässt.

STDMETHOD(get_AllowWindowlessActivation)(VARIANT_BOOL* pbAllowWindowless);

Parameter

pbAllowWindowless
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_TRUE als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::get_BackColor

Die BackColor Eigenschaft gibt die Umgebungshintergrundfarbe des Containers an.

STDMETHOD(get_BackColor)(OLE_COLOR* pclrBackground);

Parameter

pclrBackground
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet COLOR_BTNFACE oder COLOR_WINDOW als Standardwert dieser Eigenschaft (je nachdem, ob das übergeordnete Element des Hostfensters ein Dialogfeld ist oder nicht).

IAxWinAmbientDispatch::get_DisplayAsDefault

DisplayAsDefault ist eine Umgebungseigenschaft, mit der ein Steuerelement herausfinden kann, ob es sich um das Standardsteuerelement handelt.

STDMETHOD(get_DisplayAsDefault)(VARIANT_BOOL* pbDisplayAsDefault);

Parameter

pbDisplayAsDefault
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_FALSE als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::get_DocHostDoubleClickFlags

Die DocHostDoubleClickFlags Eigenschaft gibt den Vorgang an, der als Reaktion auf einen Doppelklick ausgeführt werden soll.

STDMETHOD(get_DocHostDoubleClickFlags)(DWORD* pdwDocHostDoubleClickFlags);

Parameter

pdwDocHostDoubleClickFlags
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet DOCHOSTUIDBLCLK_DEFAULT als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::get_DocHostFlags

Die DocHostFlags Eigenschaft gibt die Benutzeroberflächenfunktionen des Hostobjekts an.

STDMETHOD(get_DocHostFlags)(DWORD* pdwDocHostFlags);

Parameter

pdwDocHostFlags
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet DOCHOSTUIFLAG_NO3DBORDER als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::get_Font

Die Font Eigenschaft gibt die Umgebungsschriftart des Containers an.

STDMETHOD(get_Font)(IFontDisp** pFont);

Parameter

pFont
[out] Die Adresse eines IFontDisp Schnittstellenzeigers, der zum Empfangen des aktuellen Werts dieser Eigenschaft verwendet wird.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet die Standard-GUI-Schriftart oder die Systemschriftart als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::get_ForeColor

Die ForeColor Eigenschaft gibt die Umgebungs-Vordergrundfarbe des Containers an.

STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);

Parameter

pclrForeground
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet die Textfarbe des Systemfensters als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::get_LocaleID

Die LocaleID Eigenschaft gibt die Umgebungsgebietsschema-ID des Containers an.

STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);

Parameter

plcidLocaleID
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet das Standardgebietsschema des Benutzers als Standardwert dieser Eigenschaft.

Mit dieser Methode können Sie die Ambient LocalID ermitteln, d. h. die LocaleID des Programms, in dem Ihr Steuerelement verwendet wird. Sobald Sie die LocaleID kennen, können Sie Code aufrufen, um gebietsschemaspezifische Beschriftungen, Fehlermeldungstext usw. aus einer Ressourcendatei oder Satelliten-DLL zu laden.

IAxWinAmbientDispatch::get_MessageReflect

Die MessageReflect Umgebungseigenschaft gibt an, ob der Container Nachrichten an das gehostete Steuerelement widerspiegelt.

STDMETHOD(get_MessageReflect)(VARIANT_BOOL* pbMessageReflect);

Parameter

pbMessageReflect
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_TRUE als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::get_OptionKeyPath

Die OptionKeyPath Eigenschaft gibt den Registrierungsschlüsselpfad zu Den Benutzereinstellungen an.

STDMETHOD(get_OptionKeyPath)(BSTR* pbstrOptionKeyPath);

Parameter

pbstrOptionKeyPath
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

IAxWinAmbientDispatch::get_ShowGrabHandles

Mit ShowGrabHandles der Umgebungseigenschaft kann das Steuerelement herausfinden, ob es sich selbst mit Ziehpunkten zeichnen soll.

STDMETHOD(get_ShowGrabHandles)(VARIANT_BOOL* pbShowGrabHandles);

Parameter

pbShowGrabHandles
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung gibt immer VARIANT_FALSE als Wert dieser Eigenschaft zurück.

IAxWinAmbientDispatch::get_ShowHatching

Die ShowHatching Umgebungseigenschaft ermöglicht es dem Steuerelement herauszufinden, ob es sich selbst geschlüpft zeichnen soll.

STDMETHOD(get_ShowHatching)(VARIANT_BOOL* pbShowHatching);

Parameter

pbShowHatching
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung gibt immer VARIANT_FALSE als Wert dieser Eigenschaft zurück.

IAxWinAmbientDispatch::get_UserMode

Die UserMode Eigenschaft gibt den Umgebungsbenutzermodus des Containers an.

STDMETHOD(get_UserMode)(VARIANT_BOOL* pbUserMode);

Parameter

pbUserMode
[out] Die Adresse einer Variablen, die den aktuellen Wert dieser Eigenschaft empfängt.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_TRUE als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::p ut_AllowContextMenu

Die AllowContextMenu Eigenschaft gibt an, ob das gehostete Steuerelement sein eigenes Kontextmenü anzeigen darf.

STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);

Parameter

bAllowContextMenu
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_TRUE als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::p ut_AllowShowUI

Die AllowShowUI Eigenschaft gibt an, ob das gehostete Steuerelement seine eigene Benutzeroberfläche anzeigen darf.

STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);

Parameter

bAllowShowUI
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_FALSE als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::p ut_AllowWindowlessActivation

Die AllowWindowlessActivation Eigenschaft gibt an, ob der Container eine fensterlose Aktivierung zulässt.

STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);

Parameter

bAllowWindowless
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_TRUE als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::p ut_BackColor

Die BackColor Eigenschaft gibt die Umgebungshintergrundfarbe des Containers an.

STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);

Parameter

clrBackground
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet COLOR_BTNFACE oder COLOR_WINDOW als Standardwert dieser Eigenschaft (je nachdem, ob das übergeordnete Element des Hostfensters ein Dialogfeld ist oder nicht).

IAxWinAmbientDispatch::p ut_DisplayAsDefault

DisplayAsDefault ist eine Umgebungseigenschaft, mit der ein Steuerelement herausfinden kann, ob es sich um das Standardsteuerelement handelt.

STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);

Parameter

bDisplayAsDefault
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_FALSE als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::p ut_DocHostDoubleClickFlags

Die DocHostDoubleClickFlags Eigenschaft gibt den Vorgang an, der als Reaktion auf einen Doppelklick ausgeführt werden soll.

STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);

Parameter

dwDocHostDoubleClickFlags
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet DOCHOSTUIDBLCLK_DEFAULT als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::p ut_DocHostFlags

Die DocHostFlags Eigenschaft gibt die Benutzeroberflächenfunktionen des Hostobjekts an.

STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);

Parameter

dwDocHostFlags
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet DOCHOSTUIFLAG_NO3DBORDER als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::p ut_Font

Die Font Eigenschaft gibt die Umgebungsschriftart des Containers an.

STDMETHOD(put_Font)(IFontDisp* pFont);

Parameter

pFont
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet die Standard-GUI-Schriftart oder die Systemschriftart als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::p ut_ForeColor

Die ForeColor Eigenschaft gibt die Umgebungs-Vordergrundfarbe des Containers an.

STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);

Parameter

clrForeground
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet die Textfarbe des Systemfensters als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::p ut_LocaleID

Die LocaleID Eigenschaft gibt die Umgebungsgebietsschema-ID des Containers an.

STDMETHOD(put_LocaleID)(LCID lcidLocaleID);

Parameter

lcidLocaleID
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet das Standardgebietsschema des Benutzers als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::p ut_MessageReflect

Die MessageReflect Umgebungseigenschaft gibt an, ob der Container Nachrichten an das gehostete Steuerelement widerspiegelt.

STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);

Parameter

bMessageReflect
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_TRUE als Standardwert dieser Eigenschaft.

IAxWinAmbientDispatch::p ut_OptionKeyPath

Die OptionKeyPath Eigenschaft gibt den Registrierungsschlüsselpfad zu Den Benutzereinstellungen an.

STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);

Parameter

bstrOptionKeyPath
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

IAxWinAmbientDispatch::p ut_UserMode

Die UserMode Eigenschaft gibt den Umgebungsbenutzermodus des Containers an.

STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);

Parameter

bUserMode
[in] Der neue Wert dieser Eigenschaft.

Rückgabewert

Ein HRESULT-Standardwert.

Hinweise

Die ATL-Hostobjektimplementierung verwendet VARIANT_TRUE als Standardwert dieser Eigenschaft.

Siehe auch

IAxWinAmbientDispatchEx-Schnittstelle
IAxWinHostWindow-Schnittstelle
CAxWindow::QueryHost
AtlAxGetHost