IAxWinAmbientDispatch (interfaz)

Esta interfaz proporciona métodos para especificar características del control o contenedor hospedado.

Importante

Esta clase y sus miembros no se pueden usar en las aplicaciones que se ejecutan en Windows Runtime.

Sintaxis

interface IAxWinAmbientDispatch : IDispatch

Miembros

Métodos

Nombre	Descripción
get_AllowContextMenu	La propiedad AllowContextMenu especifica si el control hospedado puede mostrar su propio menú contextual.
get_AllowShowUI	La propiedad AllowShowUI especifica si el control hospedado puede mostrar su propia interfaz de usuario.
get_AllowWindowlessActivation	La propiedad AllowWindowlessActivation especifica si el contenedor permitirá la activación sin ventanas.
get_BackColor	La propiedad BackColor especifica el color de fondo ambiente del contenedor.
get_DisplayAsDefault	DisplayAsDefault es una propiedad de ambiente que permite a un control averiguar si el control es predeterminado.
get_DocHostDoubleClickFlags	La propiedad DocHostDoubleClickFlags especifica la operación que debe realizarse en respuesta a un doble clic.
get_DocHostFlags	La propiedad DocHostFlags especifica las funcionalidades de la interfaz de usuario del objeto host.
get_Font	La propiedad Font especifica la fuente ambiente del contenedor.
get_ForeColor	La propiedad ForeColor especifica el color de primer plano de ambiente del contenedor.
get_LocaleID	La propiedad LocaleID especifica el id. de configuración local de ambiente del contenedor.
get_MessageReflect	La propiedad ambiente MessageReflect especifica si el contenedor reflejará los mensajes en el control hospedado.
get_OptionKeyPath	La propiedadOptionKeyPath especifica la ruta de acceso de la clave del Registro a la configuración de usuario.
get_ShowGrabHandles	La propiedad ambienteShowGrabHandles permite al control averiguar si debe dibujar controladores de arrastre.
get_ShowHatching	La ShowHatching propiedad ambiente permite que el control averigüe si debe dibujase con sombreado.
get_UserMode	La propiedad UserMode especifica el modo de usuario ambiente del contenedor.
put_AllowContextMenu	La propiedad AllowContextMenu especifica si el control hospedado puede mostrar su propio menú contextual.
put_AllowShowUI	La propiedad AllowShowUI especifica si el control hospedado puede mostrar su propia interfaz de usuario.
put_AllowWindowlessActivation	La propiedad AllowWindowlessActivation especifica si el contenedor permitirá la activación sin ventanas.
put_BackColor	La propiedad BackColor especifica el color de fondo ambiente del contenedor.
put_DisplayAsDefault	DisplayAsDefault es una propiedad de ambiente que permite a un control averiguar si el control es predeterminado.
put_DocHostDoubleClickFlags	La propiedad DocHostDoubleClickFlags especifica la operación que debe realizarse en respuesta a un doble clic.
put_DocHostFlags	La propiedad DocHostFlags especifica las funcionalidades de la interfaz de usuario del objeto host.
put_Font	La propiedad Font especifica la fuente ambiente del contenedor.
put_ForeColor	La propiedad ForeColor especifica el color de primer plano de ambiente del contenedor.
put_LocaleID	La propiedad LocaleID especifica el id. de configuración local de ambiente del contenedor.
put_MessageReflect	La propiedad ambiente MessageReflect especifica si el contenedor reflejará los mensajes en el control hospedado.
put_OptionKeyPath	La propiedadOptionKeyPath especifica la ruta de acceso de la clave del Registro a la configuración de usuario.
put_UserMode	La propiedad UserMode especifica el modo de usuario ambiente del contenedor.

Comentarios

Esta interfaz se expone mediante los objetos de hospedaje de controles ActiveX de ATL. Llame a los métodos de esta interfaz para establecer las propiedades ambiente disponibles para el control hospedado o para especificar otros aspectos del comportamiento del contenedor. Para complementar las propiedades proporcionadas por IAxWinAmbientDispatch, use IAxWinAmbientDispatchEx.

AxHost intentará cargar información de tipos sobre IAxWinAmbientDispatch y IAxWinAmbientDispatchEx desde la biblioteca de tipos que contiene el código.

Si va a establecer una vinculación con ATL90.dll, AXHost cargará la información de tipos de la biblioteca de tipos en el archivo DLL.

Consulte Hospedar controles ActiveX mediante ATL AXHost para más información.

Requisitos

La definición de esta interfaz está disponible en varios formatos, como se muestra en la tabla siguiente.

Tipo de definición	Archivo
IDL	atliface.idl
Biblioteca de tipos	ATL.dll
C++	atliface.h (incluido también en ATLBase.h)

IAxWinAmbientDispatch::get_AllowContextMenu

La propiedad AllowContextMenu especifica si el control hospedado puede mostrar su propio menú contextual.

STDMETHOD(get_AllowContextMenu)(VARIANT_BOOL* pbAllowContextMenu);

Parámetros

pbAllowContextMenu
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_TRUE como valor predeterminado en esta propiedad.

IAxWinAmbientDispatch::get_AllowShowUI

La propiedad AllowShowUI especifica si el control hospedado puede mostrar su propia interfaz de usuario.

STDMETHOD(get_AllowShowUI)(VARIANT_BOOL* pbAllowShowUI);

Parámetros

pbAllowShowUI
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_FALSE como valor predeterminado en esta propiedad.

IAxWinAmbientDispatch::get_AllowWindowlessActivation

La propiedad AllowWindowlessActivation especifica si el contenedor permitirá la activación sin ventanas.

STDMETHOD(get_AllowWindowlessActivation)(VARIANT_BOOL* pbAllowWindowless);

Parámetros

pbAllowWindowless
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_TRUE como valor predeterminado en esta propiedad.

IAxWinAmbientDispatch::get_BackColor

La propiedad BackColor especifica el color de fondo ambiente del contenedor.

STDMETHOD(get_BackColor)(OLE_COLOR* pclrBackground);

Parámetros

pclrBackground
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa COLOR_BTNFACE o COLOR_WINDOW como valor predeterminado de esta propiedad (dependiendo de si el elemento primario de la ventana host es un diálogo o no).

IAxWinAmbientDispatch::get_DisplayAsDefault

DisplayAsDefault es una propiedad de ambiente que permite a un control averiguar si el control es predeterminado.

STDMETHOD(get_DisplayAsDefault)(VARIANT_BOOL* pbDisplayAsDefault);

Parámetros

pbDisplayAsDefault
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_FALSE como valor predeterminado en esta propiedad.

IAxWinAmbientDispatch::get_DocHostDoubleClickFlags

La propiedad DocHostDoubleClickFlags especifica la operación que debe realizarse en respuesta a un doble clic.

STDMETHOD(get_DocHostDoubleClickFlags)(DWORD* pdwDocHostDoubleClickFlags);

Parámetros

pdwDocHostDoubleClickFlags
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa DOCHOSTUIDBLCLK_DEFAULT como valor predeterminado de esta propiedad.

IAxWinAmbientDispatch::get_DocHostFlags

La propiedad DocHostFlags especifica las funcionalidades de la interfaz de usuario del objeto host.

STDMETHOD(get_DocHostFlags)(DWORD* pdwDocHostFlags);

Parámetros

pdwDocHostFlags
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa DOCHOSTUIFLAG_NO3DBORDER como valor predeterminado de esta propiedad.

IAxWinAmbientDispatch::get_Font

La propiedad Font especifica la fuente ambiente del contenedor.

STDMETHOD(get_Font)(IFontDisp** pFont);

Parámetros

pFont
[out] Dirección de un puntero de interfaz IFontDisp usado para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa la fuente de GUI predeterminada o la fuente del sistema como valor predeterminado de esta propiedad.

IAxWinAmbientDispatch::get_ForeColor

La propiedad ForeColor especifica el color de primer plano de ambiente del contenedor.

STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);

Parámetros

pclrForeground
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa el color de texto de la ventana del sistema como valor predeterminado de esta propiedad.

IAxWinAmbientDispatch::get_LocaleID

La propiedad LocaleID especifica el id. de configuración local de ambiente del contenedor.

STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);

Parámetros

plcidLocaleID
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa la configuración local predeterminada del usuario como valor predeterminado de esta propiedad.

Con este método puede descubrir el LocalID de ambiente, es decir, el LocaleID del programa en el que se está usando su control. Una vez que conozca el LocaleID, puede llamar al código para cargar subtítulos específicos de la configuración local, el texto del mensaje de error, etc. desde un archivo de recursos o un archivo DLL satélite.

IAxWinAmbientDispatch::get_MessageReflect

La propiedad ambiente MessageReflect especifica si el contenedor reflejará los mensajes en el control hospedado.

STDMETHOD(get_MessageReflect)(VARIANT_BOOL* pbMessageReflect);

Parámetros

pbMessageReflect
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_TRUE como valor predeterminado en esta propiedad.

IAxWinAmbientDispatch::get_OptionKeyPath

La propiedadOptionKeyPath especifica la ruta de acceso de la clave del Registro a la configuración de usuario.

STDMETHOD(get_OptionKeyPath)(BSTR* pbstrOptionKeyPath);

Parámetros

pbstrOptionKeyPath
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

IAxWinAmbientDispatch::get_ShowGrabHandles

La propiedad ambienteShowGrabHandles permite al control averiguar si debe dibujar controladores de arrastre.

STDMETHOD(get_ShowGrabHandles)(VARIANT_BOOL* pbShowGrabHandles);

Parámetros

pbShowGrabHandles
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL siempre devuelve VARIANT_FALSE como valor de esta propiedad.

IAxWinAmbientDispatch::get_ShowHatching

La ShowHatching propiedad ambiente permite que el control averigüe si debe dibujase con sombreado.

STDMETHOD(get_ShowHatching)(VARIANT_BOOL* pbShowHatching);

Parámetros

pbShowHatching
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL siempre devuelve VARIANT_FALSE como valor de esta propiedad.

IAxWinAmbientDispatch::get_UserMode

La propiedad UserMode especifica el modo de usuario ambiente del contenedor.

STDMETHOD(get_UserMode)(VARIANT_BOOL* pbUserMode);

Parámetros

pbUserMode
[out] Dirección de una variable para recibir el valor actual de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_TRUE como valor predeterminado en esta propiedad.

IAxWinAmbientDispatch::put_AllowContextMenu

La propiedad AllowContextMenu especifica si el control hospedado puede mostrar su propio menú contextual.

STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);

Parámetros

bAllowContextMenu
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_TRUE como valor predeterminado en esta propiedad.

IAxWinAmbientDispatch::put_AllowShowUI

La propiedad AllowShowUI especifica si el control hospedado puede mostrar su propia interfaz de usuario.

STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);

Parámetros

bAllowShowUI
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_FALSE como valor predeterminado en esta propiedad.

IAxWinAmbientDispatch::put_AllowWindowlessActivation

La propiedad AllowWindowlessActivation especifica si el contenedor permitirá la activación sin ventanas.

STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);

Parámetros

bAllowWindowless
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_TRUE como valor predeterminado en esta propiedad.

IAxWinAmbientDispatch::put_BackColor

La propiedad BackColor especifica el color de fondo ambiente del contenedor.

STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);

Parámetros

clrBackground
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa COLOR_BTNFACE o COLOR_WINDOW como valor predeterminado de esta propiedad (dependiendo de si el elemento primario de la ventana host es un diálogo o no).

IAxWinAmbientDispatch::put_DisplayAsDefault

DisplayAsDefault es una propiedad de ambiente que permite a un control averiguar si el control es predeterminado.

STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);

Parámetros

bDisplayAsDefault
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_FALSE como valor predeterminado en esta propiedad.

IAxWinAmbientDispatch::put_DocHostDoubleClickFlags

La propiedad DocHostDoubleClickFlags especifica la operación que debe realizarse en respuesta a un doble clic.

STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);

Parámetros

dwDocHostDoubleClickFlags
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa DOCHOSTUIDBLCLK_DEFAULT como valor predeterminado de esta propiedad.

IAxWinAmbientDispatch::put_DocHostFlags

La propiedad DocHostFlags especifica las funcionalidades de la interfaz de usuario del objeto host.

STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);

Parámetros

dwDocHostFlags
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa DOCHOSTUIFLAG_NO3DBORDER como valor predeterminado de esta propiedad.

IAxWinAmbientDispatch::put_Font

La propiedad Font especifica la fuente ambiente del contenedor.

STDMETHOD(put_Font)(IFontDisp* pFont);

Parámetros

pFont
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa la fuente de GUI predeterminada o la fuente del sistema como valor predeterminado de esta propiedad.

IAxWinAmbientDispatch::put_ForeColor

La propiedad ForeColor especifica el color de primer plano de ambiente del contenedor.

STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);

Parámetros

clrForeground
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa el color de texto de la ventana del sistema como valor predeterminado de esta propiedad.

IAxWinAmbientDispatch::put_LocaleID

La propiedad LocaleID especifica el id. de configuración local de ambiente del contenedor.

STDMETHOD(put_LocaleID)(LCID lcidLocaleID);

Parámetros

lcidLocaleID
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa la configuración local predeterminada del usuario como valor predeterminado de esta propiedad.

IAxWinAmbientDispatch::put_MessageReflect

La propiedad ambiente MessageReflect especifica si el contenedor reflejará los mensajes en el control hospedado.

STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);

Parámetros

bMessageReflect
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_TRUE como valor predeterminado en esta propiedad.

IAxWinAmbientDispatch::put_OptionKeyPath

La propiedadOptionKeyPath especifica la ruta de acceso de la clave del Registro a la configuración de usuario.

STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);

Parámetros

bstrOptionKeyPath
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

IAxWinAmbientDispatch::put_UserMode

La propiedad UserMode especifica el modo de usuario ambiente del contenedor.

STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);

Parámetros

bUserMode
[in] El nuevo valor de esta propiedad.

Valor devuelto

Valor HRESULT estándar.

Comentarios

La implementación del objeto host ATL usa VARIANT_TRUE como valor predeterminado en esta propiedad.

Consulte también

IAxWinAmbientDispatchEx (interfaz)
IAxWinHostWindow (interfaz)
CAxWindow::QueryHost
AtlAxGetHost