IAxWinAmbientDispatch – rozhraní

Toto rozhraní poskytuje metody pro určení charakteristik hostovaného ovládacího prvku nebo kontejneru.

Důležité

Tuto třídu a její členy nelze použít v aplikacích, které se spouští v prostředí Windows Runtime.

Syntaxe

interface IAxWinAmbientDispatch : IDispatch

Členové

Metody

Jméno	popis
get_AllowContextMenu	Vlastnost AllowContextMenu určuje, zda hostovaný ovládací prvek může zobrazit vlastní místní nabídku.
get_AllowShowUI	Vlastnost AllowShowUI určuje, zda hostovaný ovládací prvek může zobrazit vlastní uživatelské rozhraní.
get_AllowWindowlessActivation	Vlastnost AllowWindowlessActivation určuje, jestli kontejner povolí aktivaci bez oken.
get_BackColor	Vlastnost BackColor určuje barvu okolního pozadí kontejneru.
get_DisplayAsDefault	DisplayAsDefault je okolí vlastnost, která umožňuje ovládací prvek zjistit, zda je to výchozí ovládací prvek.
get_DocHostDoubleClickFlags	Vlastnost DocHostDoubleClickFlags určuje operaci, která by měla proběhnout v reakci na dvojité kliknutí.
get_DocHostFlags	Vlastnost DocHostFlags určuje možnosti uživatelského rozhraní hostitelského objektu.
get_Font	Vlastnost Font určuje okolní písmo kontejneru.
get_ForeColor	Vlastnost ForeColor určuje okolní barvu popředí kontejneru.
get_LocaleID	Vlastnost LocaleID určuje ID okolního národního prostředí kontejneru.
get_MessageReflexe	Okolí MessageReflect vlastnost určuje, zda kontejner bude odrážet zprávy hostovaný ovládací prvek.
get_OptionKeyPath	Vlastnost OptionKeyPath určuje cestu klíče registru k uživatelským nastavením.
get_ShowGrabHandles	Okolí ShowGrabHandles vlastnost umožňuje ovládacímu prvku zjistit, zda by se měl kreslit pomocí úchytů pro uchytnutí.
get_ShowHatching	Okolí ShowHatching vlastnost umožňuje ovládacímu prvku zjistit, zda by měl nakreslit samotný šrafovaný.
get_UserMode	Vlastnost UserMode určuje okolní uživatelský režim kontejneru.
put_AllowContextMenu	Vlastnost AllowContextMenu určuje, zda hostovaný ovládací prvek může zobrazit vlastní místní nabídku.
put_AllowShowUI	Vlastnost AllowShowUI určuje, zda hostovaný ovládací prvek může zobrazit vlastní uživatelské rozhraní.
put_AllowWindowlessActivation	Vlastnost AllowWindowlessActivation určuje, jestli kontejner povolí aktivaci bez oken.
put_BackColor	Vlastnost BackColor určuje barvu okolního pozadí kontejneru.
put_DisplayAsDefault	DisplayAsDefault je okolí vlastnost, která umožňuje ovládací prvek zjistit, zda je to výchozí ovládací prvek.
put_DocHostDoubleClickFlags	Vlastnost DocHostDoubleClickFlags určuje operaci, která by měla proběhnout v reakci na dvojité kliknutí.
put_DocHostFlags	Vlastnost DocHostFlags určuje možnosti uživatelského rozhraní hostitelského objektu.
put_Font	Vlastnost Font určuje okolní písmo kontejneru.
put_ForeColor	Vlastnost ForeColor určuje okolní barvu popředí kontejneru.
put_LocaleID	Vlastnost LocaleID určuje ID okolního národního prostředí kontejneru.
put_MessageReflexe	Okolí MessageReflect vlastnost určuje, zda kontejner bude odrážet zprávy hostovaný ovládací prvek.
put_OptionKeyPath	Vlastnost OptionKeyPath určuje cestu klíče registru k uživatelským nastavením.
put_UserMode	Vlastnost UserMode určuje okolní uživatelský režim kontejneru.

Poznámky

Toto rozhraní je vystaveno technologie ActiveX ovládacími prvky ATL, které hostují objekty. Volání metod v tomto rozhraní nastavit okolí vlastnosti dostupné hostované ovládací prvek nebo určit další aspekty chování kontejneru. Chcete-li doplnit vlastnosti poskytované IAxWinAmbientDispatch, použijte IAxWinAmbientDispatchEx.

AxHost se pokusí načíst informace o typu a IAxWinAmbientDispatchIAxWinAmbientDispatchEx z knihovny typelib, která obsahuje kód.

Pokud odkazujete na ATL90.dll, AXHost načte informace o typu z typelib v knihovně DLL.

Další podrobnosti najdete v tématu Hostování ovládacích prvků technologie ActiveX pomocí ATL AXHost.

Požadavky

Definice tohoto rozhraní je k dispozici v řadě formulářů, jak je znázorněno v tabulce níže.

Typ definice	Soubor
IDL	atliface.idl
Knihovna typů	ATL.dll
C++	atliface.h (zahrnutý také v ATLBase.h)

IAxWinAmbientDispatch::get_AllowContextMenu

Vlastnost AllowContextMenu určuje, zda hostovaný ovládací prvek může zobrazit vlastní místní nabídku.

STDMETHOD(get_AllowContextMenu)(VARIANT_BOOL* pbAllowContextMenu);

Parametry

pbAllowContextMenu
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_TRUE jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::get_AllowShowUI

Vlastnost AllowShowUI určuje, zda hostovaný ovládací prvek může zobrazit vlastní uživatelské rozhraní.

STDMETHOD(get_AllowShowUI)(VARIANT_BOOL* pbAllowShowUI);

Parametry

pbAllowShowUI
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_FALSE jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::get_AllowWindowlessActivation

Vlastnost AllowWindowlessActivation určuje, jestli kontejner povolí aktivaci bez oken.

STDMETHOD(get_AllowWindowlessActivation)(VARIANT_BOOL* pbAllowWindowless);

Parametry

pbAllowWindowless
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_TRUE jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::get_BackColor

Vlastnost BackColor určuje barvu okolního pozadí kontejneru.

STDMETHOD(get_BackColor)(OLE_COLOR* pclrBackground);

Parametry

pclrBackground
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá COLOR_BTNFACE nebo COLOR_WINDOW jako výchozí hodnotu této vlastnosti (v závislosti na tom, jestli nadřazený objekt okna hostitele je dialog nebo ne).

IAxWinAmbientDispatch::get_DisplayAsDefault

DisplayAsDefault je okolí vlastnost, která umožňuje ovládací prvek zjistit, zda je to výchozí ovládací prvek.

STDMETHOD(get_DisplayAsDefault)(VARIANT_BOOL* pbDisplayAsDefault);

Parametry

pbDisplayAsDefault
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_FALSE jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::get_DocHostDoubleClickFlags

Vlastnost DocHostDoubleClickFlags určuje operaci, která by měla proběhnout v reakci na dvojité kliknutí.

STDMETHOD(get_DocHostDoubleClickFlags)(DWORD* pdwDocHostDoubleClickFlags);

Parametry

pdwDocHostDoubleClickFlags
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá DOCHOSTUIDBLCLK_DEFAULT jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::get_DocHostFlags

Vlastnost DocHostFlags určuje možnosti uživatelského rozhraní hostitelského objektu.

STDMETHOD(get_DocHostFlags)(DWORD* pdwDocHostFlags);

Parametry

pdwDocHostFlags
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá DOCHOSTUIFLAG_NO3DBORDER jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::get_Font

Vlastnost Font určuje okolní písmo kontejneru.

STDMETHOD(get_Font)(IFontDisp** pFont);

Parametry

pFont
[ven] Adresa IFontDisp ukazatele rozhraní použitého k přijetí aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá jako výchozí hodnotu této vlastnosti výchozí písmo grafického uživatelského rozhraní nebo systémové písmo.

IAxWinAmbientDispatch::get_ForeColor

Vlastnost ForeColor určuje okolní barvu popředí kontejneru.

STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);

Parametry

pclrForeground
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace objektu hostitele ATL používá barvu textu systémového okna jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::get_LocaleID

Vlastnost LocaleID určuje ID okolního národního prostředí kontejneru.

STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);

Parametry

plcidLocaleID
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá výchozí národní prostředí uživatele jako výchozí hodnotu této vlastnosti.

Pomocí této metody můžete zjistit Ambient LocalID, tj. LocaleID programu, ve které se používá váš ovládací prvek. Jakmile znáte id národního prostředí, můžete volat kód, který načte popis specifické pro národní prostředí, text chybové zprávy atd. z souboru prostředku nebo satelitní knihovny DLL.

IAxWinAmbientDispatch::get_MessageReflexe

Okolí MessageReflect vlastnost určuje, zda kontejner bude odrážet zprávy hostovaný ovládací prvek.

STDMETHOD(get_MessageReflect)(VARIANT_BOOL* pbMessageReflect);

Parametry

pbMessage Reflexe
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_TRUE jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::get_OptionKeyPath

Vlastnost OptionKeyPath určuje cestu klíče registru k uživatelským nastavením.

STDMETHOD(get_OptionKeyPath)(BSTR* pbstrOptionKeyPath);

Parametry

pbstrOptionKeyPath
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

IAxWinAmbientDispatch::get_ShowGrabHandles

Okolí ShowGrabHandles vlastnost umožňuje ovládacímu prvku zjistit, zda by se měl kreslit pomocí úchytů pro uchytnutí.

STDMETHOD(get_ShowGrabHandles)(VARIANT_BOOL* pbShowGrabHandles);

Parametry

pbShowGrabHandles
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL vždy vrací VARIANT_FALSE jako hodnota této vlastnosti.

IAxWinAmbientDispatch::get_ShowHatching

Okolí ShowHatching vlastnost umožňuje ovládacímu prvku zjistit, zda by měl nakreslit samotný šrafovaný.

STDMETHOD(get_ShowHatching)(VARIANT_BOOL* pbShowHatching);

Parametry

pbShowHatching
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL vždy vrací VARIANT_FALSE jako hodnota této vlastnosti.

IAxWinAmbientDispatch::get_UserMode

Vlastnost UserMode určuje okolní uživatelský režim kontejneru.

STDMETHOD(get_UserMode)(VARIANT_BOOL* pbUserMode);

Parametry

pbUserMode
[ven] Adresa proměnné pro příjem aktuální hodnoty této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_TRUE jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::p ut_AllowContextMenu

Vlastnost AllowContextMenu určuje, zda hostovaný ovládací prvek může zobrazit vlastní místní nabídku.

STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);

Parametry

bAllowContextMenu
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_TRUE jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::p ut_AllowShowUI

Vlastnost AllowShowUI určuje, zda hostovaný ovládací prvek může zobrazit vlastní uživatelské rozhraní.

STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);

Parametry

bAllowShowUI
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_FALSE jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::p ut_AllowWindowlessActivation

Vlastnost AllowWindowlessActivation určuje, jestli kontejner povolí aktivaci bez oken.

STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);

Parametry

bAllowWindowless
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_TRUE jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::p ut_BackColor

Vlastnost BackColor určuje barvu okolního pozadí kontejneru.

STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);

Parametry

clrBackground
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá COLOR_BTNFACE nebo COLOR_WINDOW jako výchozí hodnotu této vlastnosti (v závislosti na tom, jestli nadřazený objekt okna hostitele je dialog nebo ne).

IAxWinAmbientDispatch::p ut_DisplayAsDefault

DisplayAsDefault je okolí vlastnost, která umožňuje ovládací prvek zjistit, zda je to výchozí ovládací prvek.

STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);

Parametry

bDisplayAsDefault
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_FALSE jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::p ut_DocHostDoubleClickFlags

Vlastnost DocHostDoubleClickFlags určuje operaci, která by měla proběhnout v reakci na dvojité kliknutí.

STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);

Parametry

dwDocHostDoubleClickFlags
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá DOCHOSTUIDBLCLK_DEFAULT jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::p ut_DocHostFlags

Vlastnost DocHostFlags určuje možnosti uživatelského rozhraní hostitelského objektu.

STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);

Parametry

dwDocHostFlags
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá DOCHOSTUIFLAG_NO3DBORDER jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::p ut_Font

Vlastnost Font určuje okolní písmo kontejneru.

STDMETHOD(put_Font)(IFontDisp* pFont);

Parametry

pFont
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá jako výchozí hodnotu této vlastnosti výchozí písmo grafického uživatelského rozhraní nebo systémové písmo.

IAxWinAmbientDispatch::p ut_ForeColor

Vlastnost ForeColor určuje okolní barvu popředí kontejneru.

STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);

Parametry

clrForeground
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace objektu hostitele ATL používá barvu textu systémového okna jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::p ut_LocaleID

Vlastnost LocaleID určuje ID okolního národního prostředí kontejneru.

STDMETHOD(put_LocaleID)(LCID lcidLocaleID);

Parametry

lcidLocaleID
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá výchozí národní prostředí uživatele jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::p ut_Message Reflexe

Okolí MessageReflect vlastnost určuje, zda kontejner bude odrážet zprávy hostovaný ovládací prvek.

STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);

Parametry

bMessage Reflexe
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_TRUE jako výchozí hodnotu této vlastnosti.

IAxWinAmbientDispatch::p ut_OptionKeyPath

Vlastnost OptionKeyPath určuje cestu klíče registru k uživatelským nastavením.

STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);

Parametry

bstrOptionKeyPath
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

IAxWinAmbientDispatch::p ut_UserMode

Vlastnost UserMode určuje okolní uživatelský režim kontejneru.

STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);

Parametry

bUserMode
[v] Nová hodnota této vlastnosti.

Vrácená hodnota

Standardní hodnota HRESULT.

Poznámky

Implementace hostitelského objektu ATL používá VARIANT_TRUE jako výchozí hodnotu této vlastnosti.

Viz také

IAxWinAmbientDispatchEx – rozhraní
IAxWinHostWindow – rozhraní
CAxWindow::QueryHost
AtlAxGetHost