IAxWinAmbientDispatch 接口
此接口提供用于指定托管控件或容器的特征的方法。
重要
无法在 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 属性指定容器的环境区域设置 ID。 |
| 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 属性指定容器的环境区域设置 ID。 |
| put_MessageReflect | MessageReflect 环境属性指定容器是否将消息反映到托管控件。 |
| put_OptionKeyPath | OptionKeyPath 属性指定用户设置的注册表项路径。 |
| put_UserMode | UserMode 属性指定容器的环境用户模式。 |
备注
此接口由 ATL 的 ActiveX 控件托管对象公开。 调用此接口上的方法可设置托管控件可用的环境属性，或指定容器行为的其他方面。 若要补充 IAxWinAmbientDispatch 提供的属性，请使用 IAxWinAmbientDispatchEx。
AxHost 将尝试从包含代码的 typelib 中加载关于 IAxWinAmbientDispatch 和 IAxWinAmbientDispatchEx 的类型信息。
如果你链接到 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 属性指定容器的环境区域设置 ID。
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::put_AllowContextMenu
AllowContextMenu 属性指定是否允许托管控件显示自身的上下文菜单。
STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);
参数
bAllowContextMenu
[in] 此属性的新值。
返回值
标准 HRESULT 值。
备注
ATL 主机对象实现使用 VARIANT_TRUE 作为此属性的默认值。
IAxWinAmbientDispatch::put_AllowShowUI
AllowShowUI 属性指定是否允许托管控件显示自身的用户界面。
STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);
参数
bAllowShowUI
[in] 此属性的新值。
返回值
标准 HRESULT 值。
备注
ATL 主机对象实现使用 VARIANT_FALSE 作为此属性的默认值。
IAxWinAmbientDispatch::put_AllowWindowlessActivation
AllowWindowlessActivation 属性指定容器是否允许无窗口激活。
STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);
参数
bAllowWindowless
[in] 此属性的新值。
返回值
标准 HRESULT 值。
备注
ATL 主机对象实现使用 VARIANT_TRUE 作为此属性的默认值。
IAxWinAmbientDispatch::put_BackColor
BackColor 属性指定容器的环境背景色。
STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);
参数
clrBackground
[in] 此属性的新值。
返回值
标准 HRESULT 值。
备注
ATL 主机对象实现使用 COLOR_BTNFACE 或 COLOR_WINDOW 作为此属性的默认值（具体取决于主机窗口的父级是否为对话框）。
IAxWinAmbientDispatch::put_DisplayAsDefault
DisplayAsDefault 是一个环境属性，它允许控件发现它是否为默认控件。
STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);
参数
bDisplayAsDefault
[in] 此属性的新值。
返回值
标准 HRESULT 值。
备注
ATL 主机对象实现使用 VARIANT_FALSE 作为此属性的默认值。
IAxWinAmbientDispatch::put_DocHostDoubleClickFlags
DocHostDoubleClickFlags 属性指定应响应双击而执行的操作。
STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);
参数
dwDocHostDoubleClickFlags
[in] 此属性的新值。
返回值
标准 HRESULT 值。
备注
ATL 主机对象实现使用 DOCHOSTUIDBLCLK_DEFAULT 作为此属性的默认值。
IAxWinAmbientDispatch::put_DocHostFlags
DocHostFlags 属性指定主机对象的用户界面功能。
STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);
参数
dwDocHostFlags
[in] 此属性的新值。
返回值
标准 HRESULT 值。
注解
ATL 主机对象实现使用 DOCHOSTUIFLAG_NO3DBORDER 作为此属性的默认值。
IAxWinAmbientDispatch::put_Font
Font 属性指定容器的环境字体。
STDMETHOD(put_Font)(IFontDisp* pFont);
参数
pFont
[in] 此属性的新值。
返回值
标准 HRESULT 值。
注解
ATL 主机对象实现使用默认 GUI 字体或系统字体作为此属性的默认值。
IAxWinAmbientDispatch::put_ForeColor
ForeColor 属性指定容器的环境前景色。
STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);
参数
clrForeground
[in] 此属性的新值。
返回值
标准 HRESULT 值。
备注
ATL 主机对象实现使用系统窗口文本颜色作为此属性的默认值。
IAxWinAmbientDispatch::put_LocaleID
LocaleID 属性指定容器的环境区域设置 ID。
STDMETHOD(put_LocaleID)(LCID lcidLocaleID);
参数
lcidLocaleID
[in] 此属性的新值。
返回值
标准 HRESULT 值。
备注
ATL 主机对象实现使用用户的默认区域设置作为此属性的默认值。
IAxWinAmbientDispatch::put_MessageReflect
MessageReflect 环境属性指定容器是否将消息反映到托管控件。
STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);
参数
bMessageReflect
[in] 此属性的新值。
返回值
标准 HRESULT 值。
备注
ATL 主机对象实现使用 VARIANT_TRUE 作为此属性的默认值。
IAxWinAmbientDispatch::put_OptionKeyPath
OptionKeyPath 属性指定用户设置的注册表项路径。
STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);
参数
bstrOptionKeyPath
[in] 此属性的新值。
返回值
标准 HRESULT 值。
IAxWinAmbientDispatch::put_UserMode
UserMode 属性指定容器的环境用户模式。
STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);
参数
bUserMode
[in] 此属性的新值。
返回值
标准 HRESULT 值。
备注
ATL 主机对象实现使用 VARIANT_TRUE 作为此属性的默认值。
另请参阅
IAxWinAmbientDispatchEx 接口
IAxWinHostWindow 接口
CAxWindow::QueryHost
AtlAxGetHost