Interface IAxWinAmbientDispatch

Essa interface fornece métodos para especificar características do controle ou contêiner hospedado.

Importante

Essa classe e os respectivos membros não podem ser usados em aplicativos executados no Windows Runtime.

Sintaxe

interface IAxWinAmbientDispatch : IDispatch

Membros

Métodos

Nome	Descrição
get_AllowContextMenu	A propriedade AllowContextMenu especifica se o controle hospedado tem permissão para exibir o próprio menu de contexto.
get_AllowShowUI	A propriedade AllowShowUI especifica se o controle hospedado tem permissão para exibir a própria interface do usuário.
get_AllowWindowlessActivation	A propriedade AllowWindowlessActivation especifica se o contêiner permitirá a ativação sem janelas.
get_BackColor	A propriedade BackColor especifica a cor da tela de fundo do ambiente do contêiner.
get_DisplayAsDefault	DisplayAsDefault é uma propriedade de ambiente que permite que um controle descubra se é o controle padrão.
get_DocHostDoubleClickFlags	A propriedade DocHostDoubleClickFlags especifica a operação que deve ocorrer em resposta a um clique duplo.
get_DocHostFlags	A propriedade DocHostFlags especifica os recursos de interface do usuário do objeto host.
get_Font	A propriedade Font especifica a fonte do ambiente do contêiner.
get_ForeColor	A propriedade ForeColor especifica a cor de primeiro plano do ambiente do contêiner.
get_LocaleID	A propriedade LocaleID especifica a ID de localidade do ambiente do contêiner.
get_MessageReflect	A propriedade ambiente MessageReflect especifica se o contêiner refletirá as mensagens para o controle hospedado.
get_OptionKeyPath	A propriedade OptionKeyPath especifica o caminho da chave do Registro para as configurações do usuário.
get_ShowGrabHandles	A propriedade de ambiente ShowGrabHandles permite que o controle descubra se ele deve desenhar-se com identificadores de captura.
get_ShowHatching	A propriedade de ambiente ShowHatching permite que o controle descubra se deve se desenhar hachurado.
get_UserMode	A propriedade UserMode especifica o modo de usuário do ambiente do contêiner.
put_AllowContextMenu	A propriedade AllowContextMenu especifica se o controle hospedado tem permissão para exibir o próprio menu de contexto.
put_AllowShowUI	A propriedade AllowShowUI especifica se o controle hospedado tem permissão para exibir a própria interface do usuário.
put_AllowWindowlessActivation	A propriedade AllowWindowlessActivation especifica se o contêiner permitirá a ativação sem janelas.
put_BackColor	A propriedade BackColor especifica a cor da tela de fundo do ambiente do contêiner.
put_DisplayAsDefault	DisplayAsDefault é uma propriedade de ambiente que permite que um controle descubra se é o controle padrão.
put_DocHostDoubleClickFlags	A propriedade DocHostDoubleClickFlags especifica a operação que deve ocorrer em resposta a um clique duplo.
put_DocHostFlags	A propriedade DocHostFlags especifica os recursos de interface do usuário do objeto host.
put_Font	A propriedade Font especifica a fonte do ambiente do contêiner.
put_ForeColor	A propriedade ForeColor especifica a cor de primeiro plano do ambiente do contêiner.
put_LocaleID	A propriedade LocaleID especifica a ID de localidade do ambiente do contêiner.
put_MessageReflect	A propriedade ambiente MessageReflect especifica se o contêiner refletirá as mensagens para o controle hospedado.
put_OptionKeyPath	A propriedade OptionKeyPath especifica o caminho da chave do Registro para as configurações do usuário.
put_UserMode	A propriedade UserMode especifica o modo de usuário do ambiente do contêiner.

Comentários

Essa interface é exposta pelos objetos de hospedagem de controle ActiveX da ATL. Chame os métodos nessa interface para definir as propriedades de ambiente disponíveis para o controle hospedado ou para especificar outros aspectos do comportamento do contêiner. Para complementar as propriedades fornecidas por IAxWinAmbientDispatch, use IAxWinAmbientDispatchEx.

AxHost tentará carregar informações de tipo de carga sobre IAxWinAmbientDispatch e IAxWinAmbientDispatchEx da typelib que contém o código.

Se você estiver vinculando a ATL90.dll, AXHost carregará as informações de tipo da typelib na DLL.

Consulte Hospedando controles ActiveX usando ATL AXHost para obter mais detalhes.

Requisitos

A definição dessa interface está disponível em vários formatos, conforme mostrado na tabela abaixo.

Tipo de definição	Arquivo
IDL	atliface.idl
Biblioteca de tipos	ATL.dll
C++	atliface.h (também incluído em ATLBase.h)

IAxWinAmbientDispatch::get_AllowContextMenu

A propriedade AllowContextMenu especifica se o controle hospedado tem permissão para exibir o próprio menu de contexto.

STDMETHOD(get_AllowContextMenu)(VARIANT_BOOL* pbAllowContextMenu);

Parâmetros

pbAllowContextMenu
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_TRUE como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::get_AllowShowUI

A propriedade AllowShowUI especifica se o controle hospedado tem permissão para exibir a própria interface do usuário.

STDMETHOD(get_AllowShowUI)(VARIANT_BOOL* pbAllowShowUI);

Parâmetros

pbAllowShowUI
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_FALSE como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::get_AllowWindowlessActivation

A propriedade AllowWindowlessActivation especifica se o contêiner permitirá a ativação sem janelas.

STDMETHOD(get_AllowWindowlessActivation)(VARIANT_BOOL* pbAllowWindowless);

Parâmetros

pbAllowWindowless
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_TRUE como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::get_BackColor

A propriedade BackColor especifica a cor da tela de fundo do ambiente do contêiner.

STDMETHOD(get_BackColor)(OLE_COLOR* pclrBackground);

Parâmetros

pclrBackground
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa COLOR_BTNFACE ou COLOR_WINDOW como o valor padrão dessa propriedade (dependendo de se o pai da janela do host é uma caixa de diálogo ou não).

IAxWinAmbientDispatch::get_DisplayAsDefault

DisplayAsDefault é uma propriedade de ambiente que permite que um controle descubra se é o controle padrão.

STDMETHOD(get_DisplayAsDefault)(VARIANT_BOOL* pbDisplayAsDefault);

Parâmetros

pbDisplayAsDefault
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_FALSE como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::get_DocHostDoubleClickFlags

A propriedade DocHostDoubleClickFlags especifica a operação que deve ocorrer em resposta a um clique duplo.

STDMETHOD(get_DocHostDoubleClickFlags)(DWORD* pdwDocHostDoubleClickFlags);

Parâmetros

pdwDocHostDoubleClickFlags
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa DOCHOSTUIDBLCLK_DEFAULT como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::get_DocHostFlags

A propriedade DocHostFlags especifica os recursos de interface do usuário do objeto host.

STDMETHOD(get_DocHostFlags)(DWORD* pdwDocHostFlags);

Parâmetros

pdwDocHostFlags
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa DOCHOSTUIFLAG_NO3DBORDER como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::get_Font

A propriedade Font especifica a fonte do ambiente do contêiner.

STDMETHOD(get_Font)(IFontDisp** pFont);

Parâmetros

pFont
[out] O endereço de um ponteiro de interface IFontDisp usado para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa a fonte GUI padrão ou a fonte do sistema como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::get_ForeColor

A propriedade ForeColor especifica a cor de primeiro plano do ambiente do contêiner.

STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);

Parâmetros

pclrForeground
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa a cor do texto da janela do sistema como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::get_LocaleID

A propriedade LocaleID especifica a ID de localidade do ambiente do contêiner.

STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);

Parâmetros

plcidLocaleID
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa a localidade padrão do usuário como o valor padrão dessa propriedade.

Com esse método, você pode descobrir a LocalID de Ambiente, ou seja, a LocaleID do programa em que seu controle está sendo usado. Depois de conhecer a LocaleID, você poderá chamar o código para carregar legendas específicas à localidade, texto da mensagem de erro, e assim por diante, de um arquivo de recurso ou DLL satélite.

IAxWinAmbientDispatch::get_MessageReflect

A propriedade ambiente MessageReflect especifica se o contêiner refletirá as mensagens para o controle hospedado.

STDMETHOD(get_MessageReflect)(VARIANT_BOOL* pbMessageReflect);

Parâmetros

pbMessageReflect
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_TRUE como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::get_OptionKeyPath

A propriedade OptionKeyPath especifica o caminho da chave do Registro para as configurações do usuário.

STDMETHOD(get_OptionKeyPath)(BSTR* pbstrOptionKeyPath);

Parâmetros

pbstrOptionKeyPath
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

IAxWinAmbientDispatch::get_ShowGrabHandles

A propriedade de ambiente ShowGrabHandles permite que o controle descubra se ele deve desenhar-se com identificadores de captura.

STDMETHOD(get_ShowGrabHandles)(VARIANT_BOOL* pbShowGrabHandles);

Parâmetros

pbShowGrabHandles
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL sempre retorna VARIANT_FALSE como o valor dessa propriedade.

IAxWinAmbientDispatch::get_ShowHatching

A propriedade de ambiente ShowHatching permite que o controle descubra se deve se desenhar hachurado.

STDMETHOD(get_ShowHatching)(VARIANT_BOOL* pbShowHatching);

Parâmetros

pbShowHatching
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL sempre retorna VARIANT_FALSE como o valor dessa propriedade.

IAxWinAmbientDispatch::get_UserMode

A propriedade UserMode especifica o modo de usuário do ambiente do contêiner.

STDMETHOD(get_UserMode)(VARIANT_BOOL* pbUserMode);

Parâmetros

pbUserMode
[out] O endereço de uma variável para receber o valor atual dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_TRUE como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::put_AllowContextMenu

A propriedade AllowContextMenu especifica se o controle hospedado tem permissão para exibir o próprio menu de contexto.

STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);

Parâmetros

bAllowContextMenu
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_TRUE como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::put_AllowShowUI

A propriedade AllowShowUI especifica se o controle hospedado tem permissão para exibir a própria interface do usuário.

STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);

Parâmetros

bAllowShowUI
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_FALSE como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::put_AllowWindowlessActivation

A propriedade AllowWindowlessActivation especifica se o contêiner permitirá a ativação sem janelas.

STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);

Parâmetros

bAllowWindowless
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_TRUE como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::put_BackColor

A propriedade BackColor especifica a cor da tela de fundo do ambiente do contêiner.

STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);

Parâmetros

clrBackground
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa COLOR_BTNFACE ou COLOR_WINDOW como o valor padrão dessa propriedade (dependendo de se o pai da janela do host é uma caixa de diálogo ou não).

IAxWinAmbientDispatch::put_DisplayAsDefault

DisplayAsDefault é uma propriedade de ambiente que permite que um controle descubra se é o controle padrão.

STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);

Parâmetros

bDisplayAsDefault
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_FALSE como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::put_DocHostDoubleClickFlags

A propriedade DocHostDoubleClickFlags especifica a operação que deve ocorrer em resposta a um clique duplo.

STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);

Parâmetros

dwDocHostDoubleClickFlags
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa DOCHOSTUIDBLCLK_DEFAULT como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::put_DocHostFlags

A propriedade DocHostFlags especifica os recursos de interface do usuário do objeto host.

STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);

Parâmetros

dwDocHostFlags
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa DOCHOSTUIFLAG_NO3DBORDER como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::put_Font

A propriedade Font especifica a fonte do ambiente do contêiner.

STDMETHOD(put_Font)(IFontDisp* pFont);

Parâmetros

pFont
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa a fonte GUI padrão ou a fonte do sistema como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::put_ForeColor

A propriedade ForeColor especifica a cor de primeiro plano do ambiente do contêiner.

STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);

Parâmetros

clrForeground
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa a cor do texto da janela do sistema como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::put_LocaleID

A propriedade LocaleID especifica a ID de localidade do ambiente do contêiner.

STDMETHOD(put_LocaleID)(LCID lcidLocaleID);

Parâmetros

lcidLocaleID
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa a localidade padrão do usuário como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::put_MessageReflect

A propriedade ambiente MessageReflect especifica se o contêiner refletirá as mensagens para o controle hospedado.

STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);

Parâmetros

bMessageReflect
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_TRUE como o valor padrão dessa propriedade.

IAxWinAmbientDispatch::put_OptionKeyPath

A propriedade OptionKeyPath especifica o caminho da chave do Registro para as configurações do usuário.

STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);

Parâmetros

bstrOptionKeyPath
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

IAxWinAmbientDispatch::put_UserMode

A propriedade UserMode especifica o modo de usuário do ambiente do contêiner.

STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);

Parâmetros

bUserMode
[in] O novo valor dessa propriedade.

Valor de retorno

Um valor HRESULT padrão.

Comentários

A implementação do objeto host ATL usa VARIANT_TRUE como o valor padrão dessa propriedade.

Confira também

Interface IAxWinAmbientDispatchEx
Interface IAxWinHostWindow
CAxWindow::QueryHost
AtlAxGetHost