Partilhar via


IAxWinAmbientDispatch Interface

Observação

A Active Template Library (ATL) continua a ser suportada. No entanto, já não estamos a adicionar funcionalidades nem a atualizar a documentação.

Esta interface fornece métodos para especificar características do controlo ou contentor hospedado.

Importante

Esta classe e os seus membros não podem ser usados em aplicações que sejam executadas no Windows Runtime.

Sintaxe

interface IAxWinAmbientDispatch : IDispatch

Membros

Methods

Nome Description
get_AllowContextMenu A AllowContextMenu propriedade especifica se o controlo hospedado pode mostrar o seu próprio menu de contexto.
get_AllowShowUI A AllowShowUI propriedade especifica se o controlo alojado pode exibir a sua própria interface de utilizador.
get_AllowWindowlessActivation A AllowWindowlessActivation propriedade especifica se o contentor permitirá ativação sem janelas.
get_BackColor A BackColor propriedade especifica a cor de fundo ambiente do contentor.
get_DisplayAsDefault DisplayAsDefault é uma propriedade ambiente que permite a um controlo descobrir se é o controlo padrão.
get_DocHostDoubleClickFlags A DocHostDoubleClickFlags propriedade especifica a operação que deve ocorrer em resposta a um duplo clique.
get_DocHostFlags A DocHostFlags propriedade especifica as capacidades da interface de utilizador do objeto anfitrião.
get_Font A Font propriedade especifica a fonte ambiente do contentor.
get_ForeColor A ForeColor propriedade especifica a cor ambiente em primeiro plano do recipiente.
get_LocaleID A LocaleID propriedade especifica o ID de local ambiente do contentor.
get_MessageReflect A MessageReflect propriedade ambiente especifica se o contentor irá refletir mensagens para o controlo alojado.
get_OptionKeyPath A OptionKeyPath propriedade especifica o caminho da chave de registo para as definições do utilizador.
get_ShowGrabHandles A ShowGrabHandles propriedade ambiente permite ao controlo descobrir se deve desenhar-se com alças de agarre.
get_ShowHatching A ShowHatching propriedade ambiente permite ao controlo determinar se deve desenhar-se a si próprio com hacha.
get_UserMode A UserMode propriedade especifica o modo ambiente do utilizador do contentor.
put_AllowContextMenu A AllowContextMenu propriedade especifica se o controlo hospedado pode mostrar o seu próprio menu de contexto.
put_AllowShowUI A AllowShowUI propriedade especifica se o controlo alojado pode exibir a sua própria interface de utilizador.
put_AllowWindowlessActivation A AllowWindowlessActivation propriedade especifica se o contentor permitirá ativação sem janelas.
put_BackColor A BackColor propriedade especifica a cor de fundo ambiente do contentor.
put_DisplayAsDefault DisplayAsDefault é uma propriedade ambiente que permite a um controlo descobrir se é o controlo padrão.
put_DocHostDoubleClickFlags A DocHostDoubleClickFlags propriedade especifica a operação que deve ocorrer em resposta a um duplo clique.
put_DocHostFlags A DocHostFlags propriedade especifica as capacidades da interface de utilizador do objeto anfitrião.
put_Font A Font propriedade especifica a fonte ambiente do contentor.
put_ForeColor A ForeColor propriedade especifica a cor ambiente em primeiro plano do recipiente.
put_LocaleID A LocaleID propriedade especifica o ID de local ambiente do contentor.
put_MessageReflect A MessageReflect propriedade ambiente especifica se o contentor irá refletir mensagens para o controlo alojado.
put_OptionKeyPath A OptionKeyPath propriedade especifica o caminho da chave de registo para as definições do utilizador.
put_UserMode A UserMode propriedade especifica o modo ambiente do utilizador do contentor.

Observações

Esta interface é exposta pelos objetos de alojamento de controlo ActiveX da ATL. Chame os métodos nesta interface para definir as propriedades ambientais disponíveis para o controlo hospedado ou para especificar outros aspetos do comportamento do contentor. Para complementar as propriedades fornecidas por IAxWinAmbientDispatch, use IAxWinAmbientDispatchEx.

AxHost tentará carregar informação de tipo sobre IAxWinAmbientDispatch e IAxWinAmbientDispatchEx a partir da typelib que contém o código.

Se estiveres a ligar para ATL90.dll, o AXHost vai carregar a informação de tipo da typelib na DLL.

Consulte Hospedagem de Controlos ActiveX usando ATL AXHost para mais detalhes.

Requerimentos

A definição desta interface está disponível em várias formas, como mostrado na tabela abaixo.

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

IAxWinAmbientDispatch::get_AllowContextMenu

A AllowContextMenu propriedade especifica se o controlo hospedado pode mostrar o seu próprio menu de contexto.

STDMETHOD(get_AllowContextMenu)(VARIANT_BOOL* pbAllowContextMenu);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::get_AllowShowUI

A AllowShowUI propriedade especifica se o controlo alojado pode exibir a sua própria interface de utilizador.

STDMETHOD(get_AllowShowUI)(VARIANT_BOOL* pbAllowShowUI);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL usa VARIANT_FALSE como valor predefinido desta propriedade.

IAxWinAmbientDispatch::get_AllowWindowlessActivation

A AllowWindowlessActivation propriedade especifica se o contentor permitirá ativação sem janelas.

STDMETHOD(get_AllowWindowlessActivation)(VARIANT_BOOL* pbAllowWindowless);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::get_BackColor

A BackColor propriedade especifica a cor de fundo ambiente do contentor.

STDMETHOD(get_BackColor)(OLE_COLOR* pclrBackground);

Parâmetros

pclrContexto
[fora] O endereço de uma variável para receber o valor atual desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::get_DisplayAsDefault

DisplayAsDefault é uma propriedade ambiente que permite a um controlo descobrir se é o controlo padrão.

STDMETHOD(get_DisplayAsDefault)(VARIANT_BOOL* pbDisplayAsDefault);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL usa VARIANT_FALSE como valor predefinido desta propriedade.

IAxWinAmbientDispatch::get_DocHostDoubleClickFlags

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

STDMETHOD(get_DocHostDoubleClickFlags)(DWORD* pdwDocHostDoubleClickFlags);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL usa DOCHOSTUIDBLCLK_DEFAULT como valor predefinido desta propriedade.

IAxWinAmbientDispatch::get_DocHostFlags

A DocHostFlags propriedade especifica as capacidades da interface de utilizador do objeto anfitrião.

STDMETHOD(get_DocHostFlags)(DWORD* pdwDocHostFlags);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::get_Font

A Font propriedade especifica a fonte ambiente do contentor.

STDMETHOD(get_Font)(IFontDisp** pFont);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL utiliza a fonte GUI por defeito ou a fonte do sistema como valor predefinido desta propriedade.

IAxWinAmbientDispatch::get_ForeColor

A ForeColor propriedade especifica a cor ambiente em primeiro plano do recipiente.

STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);

Parâmetros

pclrPrimeiro plano
[fora] O endereço de uma variável para receber o valor atual desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::get_LocaleID

A LocaleID propriedade especifica o ID de local ambiente do contentor.

STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL usa a localização padrão do utilizador como valor padrão desta propriedade.

Com este método pode descobrir o Ambient LocalID, ou seja, o LocaleID do programa em que o seu controlo está a ser utilizado. Depois de saber o LocaleID, pode chamar código para carregar legendas específicas de local, mensagens de erro e assim por diante a partir de um ficheiro de recurso ou DLL de satélite.

IAxWinAmbientDispatch::get_MessageReflect

A MessageReflect propriedade ambiente especifica se o contentor irá refletir mensagens para o controlo alojado.

STDMETHOD(get_MessageReflect)(VARIANT_BOOL* pbMessageReflect);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::get_OptionKeyPath

A OptionKeyPath propriedade especifica o caminho da chave de registo para as definições do utilizador.

STDMETHOD(get_OptionKeyPath)(BSTR* pbstrOptionKeyPath);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

IAxWinAmbientDispatch::get_ShowGrabHandles

A ShowGrabHandles propriedade ambiente permite ao controlo descobrir se deve desenhar-se com alças de agarre.

STDMETHOD(get_ShowGrabHandles)(VARIANT_BOOL* pbShowGrabHandles);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL devolve sempre VARIANT_FALSE como valor desta propriedade.

IAxWinAmbientDispatch::get_ShowHatching

A ShowHatching propriedade ambiente permite ao controlo determinar se deve desenhar-se a si próprio com hacha.

STDMETHOD(get_ShowHatching)(VARIANT_BOOL* pbShowHatching);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL devolve sempre VARIANT_FALSE como valor desta propriedade.

IAxWinAmbientDispatch::get_UserMode

A UserMode propriedade especifica o modo ambiente do utilizador do contentor.

STDMETHOD(get_UserMode)(VARIANT_BOOL* pbUserMode);

Parâmetros

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

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::p ut_AllowContextMenu

A AllowContextMenu propriedade especifica se o controlo hospedado pode mostrar o seu próprio menu de contexto.

STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);

Parâmetros

bAlAlContextMenu
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::p ut_AllowShowUI

A AllowShowUI propriedade especifica se o controlo alojado pode exibir a sua própria interface de utilizador.

STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);

Parâmetros

bAllowShowUI
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL usa VARIANT_FALSE como valor predefinido desta propriedade.

IAxWinAmbientDispatch::p ut_AllowWindowlessActivation

A AllowWindowlessActivation propriedade especifica se o contentor permitirá ativação sem janelas.

STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);

Parâmetros

bAllowWindowless
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::p ut_BackColor

A BackColor propriedade especifica a cor de fundo ambiente do contentor.

STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);

Parâmetros

clrContexto
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::p ut_DisplayAsDefault

DisplayAsDefault é uma propriedade ambiente que permite a um controlo descobrir se é o controlo padrão.

STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);

Parâmetros

bDisplayAsPadrão
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL usa VARIANT_FALSE como valor predefinido desta propriedade.

IAxWinAmbientDispatch::p ut_DocHostDoubleClickFlags

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

STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);

Parâmetros

dwDocHostDoubleClickFlags
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL usa DOCHOSTUIDBLCLK_DEFAULT como valor predefinido desta propriedade.

IAxWinAmbientDispatch::p ut_DocHostFlags

A DocHostFlags propriedade especifica as capacidades da interface de utilizador do objeto anfitrião.

STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);

Parâmetros

dwDocHostFlags
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::p ut_Font

A Font propriedade especifica a fonte ambiente do contentor.

STDMETHOD(put_Font)(IFontDisp* pFont);

Parâmetros

pFont
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL utiliza a fonte GUI por defeito ou a fonte do sistema como valor predefinido desta propriedade.

IAxWinAmbientDispatch::p ut_ForeColor

A ForeColor propriedade especifica a cor ambiente em primeiro plano do recipiente.

STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);

Parâmetros

clrForeground
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::p ut_LocaleID

A LocaleID propriedade especifica o ID de local ambiente do contentor.

STDMETHOD(put_LocaleID)(LCID lcidLocaleID);

Parâmetros

lcidLocaleID
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

A implementação do objeto host ATL usa a localização padrão do utilizador como valor padrão desta propriedade.

IAxWinAmbientDispatch::p ut_MessageReflect

A MessageReflect propriedade ambiente especifica se o contentor irá refletir mensagens para o controlo alojado.

STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);

Parâmetros

bMessageReflect
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

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

IAxWinAmbientDispatch::p ut_OptionKeyPath

A OptionKeyPath propriedade especifica o caminho da chave de registo para as definições do utilizador.

STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);

Parâmetros

bstrOptionKeyPath
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

IAxWinAmbientDispatch::p ut_UserMode

A UserMode propriedade especifica o modo ambiente do utilizador do contentor.

STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);

Parâmetros

bUserMode
[dentro] O novo valor desta propriedade.

Valor de retorno

Um valor HRESULT padrão.

Observações

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

Consulte também

IAxWinAmbientDispatchEx Interface
IAxWinHostWindow Interface
CAxWindow::QueryHost
AtlAxGetHost