IAxWinAmbientDispatch 介面

發行項
08/03/2024

這個介面提供方法來指定裝載控件或容器的特性。

重要

這個類別及其成員不能用於在 Windows 執行階段中執行的應用程式。

語法

interface IAxWinAmbientDispatch : IDispatch

成員

方法

名稱	描述
get_AllowContextMenu	屬性 `AllowContextMenu` 會指定是否允許主控控件顯示自己的操作功能表。
get_AllowShowUI	屬性 `AllowShowUI` 會指定是否允許主控控件顯示自己的使用者介面。
get_AllowWindowlessActivation	屬性 `AllowWindowlessActivation` 會指定容器是否允許無窗口啟用。
get_BackColor	屬性 `BackColor` 會指定容器的環境背景色彩。
get_DisplayAsDefault	`DisplayAsDefault` 是環境屬性，可讓控件找出其是否為預設控件。
get_DocHostDoubleClickFlags	屬性 `DocHostDoubleClickFlags` 會指定應該在回應按兩下時進行的作業。
get_DocHostFlags	屬性 `DocHostFlags` 會指定主物件的使用者介面功能。
get_Font	屬性 `Font` 會指定容器的環境字型。
get_ForeColor	屬性 `ForeColor` 會指定容器的環境前景色彩。
get_LocaleID	屬性 `LocaleID` 會指定容器的環境地區設定標識碼。
get_MessageReflect	`MessageReflect`環境屬性會指定容器是否會反映裝載控件的訊息。
get_OptionKeyPath	屬性 `OptionKeyPath` 會指定使用者設定的登錄機碼路徑。
get_ShowGrabHandles	`ShowGrabHandles`環境屬性可讓控件找出它是否應該使用抓取控點繪製本身。
get_ShowHatching	`ShowHatching`環境屬性可讓控件找出它是否應該繪製本身的影線。
get_UserMode	屬性 `UserMode` 會指定容器的環境使用者模式。
put_AllowContextMenu	屬性 `AllowContextMenu` 會指定是否允許主控控件顯示自己的操作功能表。
put_AllowShowUI	屬性 `AllowShowUI` 會指定是否允許主控控件顯示自己的使用者介面。
put_AllowWindowlessActivation	屬性 `AllowWindowlessActivation` 會指定容器是否允許無窗口啟用。
put_BackColor	屬性 `BackColor` 會指定容器的環境背景色彩。
put_DisplayAsDefault	`DisplayAsDefault` 是環境屬性，可讓控件找出其是否為預設控件。
put_DocHostDoubleClickFlags	屬性 `DocHostDoubleClickFlags` 會指定應該在回應按兩下時進行的作業。
put_DocHostFlags	屬性 `DocHostFlags` 會指定主物件的使用者介面功能。
put_Font	屬性 `Font` 會指定容器的環境字型。
put_ForeColor	屬性 `ForeColor` 會指定容器的環境前景色彩。
put_LocaleID	屬性 `LocaleID` 會指定容器的環境地區設定標識碼。
put_MessageReflect	`MessageReflect`環境屬性會指定容器是否會反映裝載控件的訊息。
put_OptionKeyPath	屬性 `OptionKeyPath` 會指定使用者設定的登錄機碼路徑。
put_UserMode	屬性 `UserMode` 會指定容器的環境使用者模式。

備註

此介面是由 ATL 的 ActiveX 控制件主控對象公開。呼叫這個介面上的方法，以設定裝載控件可用的環境屬性，或指定容器行為的其他層面。若要補充所提供的 IAxWinAmbientDispatch屬性，請使用 IAxWinAmbientDispatchEx。

AxHost會嘗試從包含程序代碼的 typelib 載入和 IAxWinAmbientDispatchEx 的型別資訊IAxWinAmbientDispatch。

如果您要連結至 ATL90.dll，AXHost 會從 DLL 中的 typelib 載入類型資訊。

如需詳細資訊，請參閱使用 ATL AXHost 裝載 ActiveX 控制件。

需求

此介面的定義以多種形式提供，如下表所示。

定義類型	檔案
IDL	atliface.idl
型別程式庫	ATL.dll
C++	atliface.h （也包含在 ATLBase.h 中）

IAxWinAmbientDispatch：：get_AllowContextMenu

屬性 AllowContextMenu 會指定是否允許主控控件顯示自己的操作功能表。

STDMETHOD(get_AllowContextMenu)(VARIANT_BOOL* pbAllowContextMenu);

參數

pbAllowContextMenu
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_TRUE 做為此屬性的預設值。

IAxWinAmbientDispatch：：get_AllowShowUI

屬性 AllowShowUI 會指定是否允許主控控件顯示自己的使用者介面。

STDMETHOD(get_AllowShowUI)(VARIANT_BOOL* pbAllowShowUI);

參數

pbAllowShowUI
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_FALSE 做為此屬性的預設值。

IAxWinAmbientDispatch：：get_AllowWindowlessActivation

屬性 AllowWindowlessActivation 會指定容器是否允許無窗口啟用。

STDMETHOD(get_AllowWindowlessActivation)(VARIANT_BOOL* pbAllowWindowless);

參數

pbAllowWindowless
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_TRUE 做為此屬性的預設值。

IAxWinAmbientDispatch：：get_BackColor

屬性 BackColor 會指定容器的環境背景色彩。

STDMETHOD(get_BackColor)(OLE_COLOR* pclrBackground);

參數

pclrBackground
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機對象實作會使用 COLOR_BTNFACE 或 COLOR_WINDOW 做為此屬性的預設值（視主機視窗的父代是否為對話框而定）。

IAxWinAmbientDispatch：：get_DisplayAsDefault

DisplayAsDefault 是環境屬性，可讓控件找出其是否為預設控件。

STDMETHOD(get_DisplayAsDefault)(VARIANT_BOOL* pbDisplayAsDefault);

參數

pbDisplayAsDefault
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_FALSE 做為此屬性的預設值。

IAxWinAmbientDispatch：：get_DocHostDoubleClickFlags

屬性 DocHostDoubleClickFlags 會指定應該在回應按兩下時進行的作業。

STDMETHOD(get_DocHostDoubleClickFlags)(DWORD* pdwDocHostDoubleClickFlags);

參數

pdwDocHostDoubleClickFlags
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 DOCHOSTUIDBLCLK_DEFAULT 做為此屬性的預設值。

IAxWinAmbientDispatch：：get_DocHostFlags

屬性 DocHostFlags 會指定主物件的使用者介面功能。

STDMETHOD(get_DocHostFlags)(DWORD* pdwDocHostFlags);

參數

pdwDocHostFlags
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 DOCHOSTUIFLAG_NO3DBORDER 做為此屬性的預設值。

IAxWinAmbientDispatch：：get_Font

屬性 Font 會指定容器的環境字型。

STDMETHOD(get_Font)(IFontDisp** pFont);

參數

pFont
[out]介面指標的位址 IFontDisp ，用來接收這個屬性的目前值。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用預設 GUI 字型或系統字型做為此屬性的預設值。

IAxWinAmbientDispatch：：get_ForeColor

屬性 ForeColor 會指定容器的環境前景色彩。

STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);

參數

pclrForeground
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用系統視窗文字色彩做為此屬性的預設值。

IAxWinAmbientDispatch：：get_LocaleID

屬性 LocaleID 會指定容器的環境地區設定標識碼。

STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);

參數

plcidLocaleID
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機對象實作會使用使用者的預設地區設定做為此屬性的預設值。

透過此方法，您可以探索環境 LocalID，也就是控件所使用的程式 LocaleID。一旦知道 LocaleID，您就可以呼叫程式代碼，從資源檔或附屬 DLL 載入地區設定特定的標題、錯誤訊息文字等等。

IAxWinAmbientDispatch：：get_MessageReflect

MessageReflect環境屬性會指定容器是否會反映裝載控件的訊息。

STDMETHOD(get_MessageReflect)(VARIANT_BOOL* pbMessageReflect);

參數

pbMessageReflect
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_TRUE 做為此屬性的預設值。

IAxWinAmbientDispatch：：get_OptionKeyPath

屬性 OptionKeyPath 會指定使用者設定的登錄機碼路徑。

STDMETHOD(get_OptionKeyPath)(BSTR* pbstrOptionKeyPath);

參數

pbstrOptionKeyPath
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

IAxWinAmbientDispatch：：get_ShowGrabHandles

ShowGrabHandles環境屬性可讓控件找出它是否應該使用抓取控點繪製本身。

STDMETHOD(get_ShowGrabHandles)(VARIANT_BOOL* pbShowGrabHandles);

參數

pbShowGrabHandles
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機對象實作一律會傳回VARIANT_FALSE做為此屬性的值。

IAxWinAmbientDispatch：：get_ShowHatching

ShowHatching環境屬性可讓控件找出它是否應該繪製本身的影線。

STDMETHOD(get_ShowHatching)(VARIANT_BOOL* pbShowHatching);

參數

pbShowHatching
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機對象實作一律會傳回VARIANT_FALSE做為此屬性的值。

IAxWinAmbientDispatch：：get_UserMode

屬性 UserMode 會指定容器的環境使用者模式。

STDMETHOD(get_UserMode)(VARIANT_BOOL* pbUserMode);

參數

pbUserMode
[out]要接收此屬性目前值的變數位址。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_TRUE 做為此屬性的預設值。

IAxWinAmbientDispatch：:p ut_AllowContextMenu

屬性 AllowContextMenu 會指定是否允許主控控件顯示自己的操作功能表。

STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);

參數

bAllowContextMenu
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_TRUE 做為此屬性的預設值。

IAxWinAmbientDispatch：:p ut_AllowShowUI

屬性 AllowShowUI 會指定是否允許主控控件顯示自己的使用者介面。

STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);

參數

bAllowShowUI
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_FALSE 做為此屬性的預設值。

IAxWinAmbientDispatch：:p ut_AllowWindowlessActivation

屬性 AllowWindowlessActivation 會指定容器是否允許無窗口啟用。

STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);

參數

bAllowWindowless
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_TRUE 做為此屬性的預設值。

IAxWinAmbientDispatch：:p ut_BackColor

屬性 BackColor 會指定容器的環境背景色彩。

STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);

參數

clrBackground
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機對象實作會使用 COLOR_BTNFACE 或 COLOR_WINDOW 做為此屬性的預設值（視主機視窗的父代是否為對話框而定）。

IAxWinAmbientDispatch：:p ut_DisplayAsDefault

DisplayAsDefault 是環境屬性，可讓控件找出其是否為預設控件。

STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);

參數

bDisplayAsDefault
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_FALSE 做為此屬性的預設值。

IAxWinAmbientDispatch：:p ut_DocHostDoubleClickFlags

屬性 DocHostDoubleClickFlags 會指定應該在回應按兩下時進行的作業。

STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);

參數

dwDocHostDoubleClickFlags
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 DOCHOSTUIDBLCLK_DEFAULT 做為此屬性的預設值。

IAxWinAmbientDispatch：:p ut_DocHostFlags

屬性 DocHostFlags 會指定主物件的使用者介面功能。

STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);

參數

dwDocHostFlags
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 DOCHOSTUIFLAG_NO3DBORDER 做為此屬性的預設值。

IAxWinAmbientDispatch：:p ut_Font

屬性 Font 會指定容器的環境字型。

STDMETHOD(put_Font)(IFontDisp* pFont);

參數

pFont
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用預設 GUI 字型或系統字型做為此屬性的預設值。

IAxWinAmbientDispatch：:p ut_ForeColor

屬性 ForeColor 會指定容器的環境前景色彩。

STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);

參數

clrForeground
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用系統視窗文字色彩做為此屬性的預設值。

IAxWinAmbientDispatch：:p ut_LocaleID

屬性 LocaleID 會指定容器的環境地區設定標識碼。

STDMETHOD(put_LocaleID)(LCID lcidLocaleID);

參數

lcidLocaleID
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機對象實作會使用使用者的預設地區設定做為此屬性的預設值。

IAxWinAmbientDispatch：:p ut_MessageReflect

MessageReflect環境屬性會指定容器是否會反映裝載控件的訊息。

STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);

參數

bMessageReflect
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_TRUE 做為此屬性的預設值。

IAxWinAmbientDispatch：:p ut_OptionKeyPath

屬性 OptionKeyPath 會指定使用者設定的登錄機碼路徑。

STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);

參數

bstrOptionKeyPath
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

IAxWinAmbientDispatch：:p ut_UserMode

屬性 UserMode 會指定容器的環境使用者模式。

STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);

參數

bUserMode
[in]這個屬性的新值。

傳回值

標準 HRESULT 值。

備註

ATL 主機物件實作會使用 VARIANT_TRUE 做為此屬性的預設值。

另請參閱

IAxWinAmbientDispatchEx 介面
 IAxWinHostWindow 介面
 CAxWindow：：QueryHost
AtlAxGetHost

共用方式為

IAxWinAmbientDispatch 介面

語法

成員

方法

備註

需求

IAxWinAmbientDispatch：：get_AllowContextMenu

參數

傳回值

備註

IAxWinAmbientDispatch：：get_AllowShowUI

參數

傳回值

備註

IAxWinAmbientDispatch：：get_AllowWindowlessActivation

參數

傳回值

備註

IAxWinAmbientDispatch：：get_BackColor

參數

傳回值

備註

IAxWinAmbientDispatch：：get_DisplayAsDefault

參數

傳回值

備註

IAxWinAmbientDispatch：：get_DocHostDoubleClickFlags

參數

傳回值

備註

IAxWinAmbientDispatch：：get_DocHostFlags

參數

傳回值

備註

IAxWinAmbientDispatch：：get_Font

參數

傳回值

備註

IAxWinAmbientDispatch：：get_ForeColor

參數

傳回值

備註

IAxWinAmbientDispatch：：get_LocaleID

參數

傳回值

備註

IAxWinAmbientDispatch：：get_MessageReflect

參數

傳回值

備註

IAxWinAmbientDispatch：：get_OptionKeyPath

參數

傳回值

IAxWinAmbientDispatch：：get_ShowGrabHandles

參數

傳回值

備註

IAxWinAmbientDispatch：：get_ShowHatching

參數

傳回值

備註

IAxWinAmbientDispatch：：get_UserMode

參數

傳回值

備註

IAxWinAmbientDispatch：:p ut_AllowContextMenu

參數

傳回值

備註

IAxWinAmbientDispatch：:p ut_AllowShowUI

參數

傳回值

備註

IAxWinAmbientDispatch：:p ut_AllowWindowlessActivation

參數

傳回值

備註

IAxWinAmbientDispatch：:p ut_BackColor

參數