IAxWinAmbientDispatch, interface

Cette interface fournit des méthodes pour spécifier les caractéristiques du contrôle hébergé ou du conteneur.

Important

Cette classe et ses membres ne peuvent pas être utilisés dans les applications qui s’exécutent dans Windows Runtime.

Syntaxe

interface IAxWinAmbientDispatch : IDispatch

Membres

Méthodes

Nom	Description
get_AllowContextMenu	La AllowContextMenu propriété spécifie si le contrôle hébergé est autorisé à afficher son propre menu contextuel.
get_AllowShowUI	La AllowShowUI propriété spécifie si le contrôle hébergé est autorisé à afficher sa propre interface utilisateur.
get_AllowWindowlessActivation	La AllowWindowlessActivation propriété spécifie si le conteneur autorise l’activation sans fenêtre.
get_BackColor	La BackColor propriété spécifie la couleur d’arrière-plan ambiante du conteneur.
get_DisplayAsDefault	DisplayAsDefault est une propriété ambiante qui permet à un contrôle de déterminer s’il s’agit du contrôle par défaut.
get_DocHostDoubleClickFlags	La DocHostDoubleClickFlags propriété spécifie l’opération qui doit avoir lieu en réponse à un double-clic.
get_DocHostFlags	La DocHostFlags propriété spécifie les fonctionnalités d’interface utilisateur de l’objet hôte.
get_Font	La Font propriété spécifie la police ambiante du conteneur.
get_ForeColor	La ForeColor propriété spécifie la couleur de premier plan ambiante du conteneur.
get_LocaleID	La LocaleID propriété spécifie l’ID des paramètres régionaux ambiants du conteneur.
get_MessageRéflexions	La MessageReflect propriété ambiante spécifie si le conteneur reflète les messages au contrôle hébergé.
get_OptionKeyPath	La OptionKeyPath propriété spécifie le chemin d’accès de la clé de Registre aux paramètres utilisateur.
get_ShowGrabHandles	La ShowGrabHandles propriété ambiante permet au contrôle de déterminer s’il doit se dessiner avec des poignées de saisie.
get_ShowHatching	La ShowHatching propriété ambiante permet au contrôle de déterminer s’il doit se dessiner lui-même.
get_UserMode	La UserMode propriété spécifie le mode utilisateur ambiant du conteneur.
put_AllowContextMenu	La AllowContextMenu propriété spécifie si le contrôle hébergé est autorisé à afficher son propre menu contextuel.
put_AllowShowUI	La AllowShowUI propriété spécifie si le contrôle hébergé est autorisé à afficher sa propre interface utilisateur.
put_AllowWindowlessActivation	La AllowWindowlessActivation propriété spécifie si le conteneur autorise l’activation sans fenêtre.
put_BackColor	La BackColor propriété spécifie la couleur d’arrière-plan ambiante du conteneur.
put_DisplayAsDefault	DisplayAsDefault est une propriété ambiante qui permet à un contrôle de déterminer s’il s’agit du contrôle par défaut.
put_DocHostDoubleClickFlags	La DocHostDoubleClickFlags propriété spécifie l’opération qui doit avoir lieu en réponse à un double-clic.
put_DocHostFlags	La DocHostFlags propriété spécifie les fonctionnalités d’interface utilisateur de l’objet hôte.
put_Font	La Font propriété spécifie la police ambiante du conteneur.
put_ForeColor	La ForeColor propriété spécifie la couleur de premier plan ambiante du conteneur.
put_LocaleID	La LocaleID propriété spécifie l’ID des paramètres régionaux ambiants du conteneur.
put_MessageRéflexions	La MessageReflect propriété ambiante spécifie si le conteneur reflète les messages au contrôle hébergé.
put_OptionKeyPath	La OptionKeyPath propriété spécifie le chemin d’accès de la clé de Registre aux paramètres utilisateur.
put_UserMode	La UserMode propriété spécifie le mode utilisateur ambiant du conteneur.

Notes

Cette interface est exposée par les objets d’hébergement de contrôle ActiveX d’ATL. Appelez les méthodes sur cette interface pour définir les propriétés ambiantes disponibles pour le contrôle hébergé ou pour spécifier d’autres aspects du comportement du conteneur. Pour compléter les propriétés fournies par IAxWinAmbientDispatch, utilisez IAxWinAmbientDispatchEx.

AxHost essaiera de charger des informations de type sur IAxWinAmbientDispatch et IAxWinAmbientDispatchEx à partir du typelib qui contient le code.

Si vous établissez une liaison à ATL90.dll, AXHost charge les informations de type à partir du typelib dans la DLL.

Pour plus d’informations, consultez Hébergement de contrôles ActiveX à l’aide d’ATL AXHost .

Spécifications

La définition de cette interface est disponible dans un certain nombre de formulaires, comme indiqué dans le tableau ci-dessous.

Type de définition	Fichier
IDL	atliface.idl
Bibliothèque de types	ATL.dll
C++	atliface.h (également inclus dans ATLBase.h)

IAxWinAmbientDispatch ::get_AllowContextMenu

La AllowContextMenu propriété spécifie si le contrôle hébergé est autorisé à afficher son propre menu contextuel.

STDMETHOD(get_AllowContextMenu)(VARIANT_BOOL* pbAllowContextMenu);

Paramètres

pbAllowContextMenu
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_TRUE comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::get_AllowShowUI

La AllowShowUI propriété spécifie si le contrôle hébergé est autorisé à afficher sa propre interface utilisateur.

STDMETHOD(get_AllowShowUI)(VARIANT_BOOL* pbAllowShowUI);

Paramètres

pbAllowShowUI
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_FALSE comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::get_AllowWindowlessActivation

La AllowWindowlessActivation propriété spécifie si le conteneur autorise l’activation sans fenêtre.

STDMETHOD(get_AllowWindowlessActivation)(VARIANT_BOOL* pbAllowWindowless);

Paramètres

pbAllowWindowless
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_TRUE comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::get_BackColor

La BackColor propriété spécifie la couleur d’arrière-plan ambiante du conteneur.

STDMETHOD(get_BackColor)(OLE_COLOR* pclrBackground);

Paramètres

pclrBackground
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise COLOR_BTNFACE ou COLOR_WINDOW comme valeur par défaut de cette propriété (selon que le parent de la fenêtre hôte est un dialogue ou non).

IAxWinAmbientDispatch ::get_DisplayAsDefault

DisplayAsDefault est une propriété ambiante qui permet à un contrôle de déterminer s’il s’agit du contrôle par défaut.

STDMETHOD(get_DisplayAsDefault)(VARIANT_BOOL* pbDisplayAsDefault);

Paramètres

pbDisplayAsDefault
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_FALSE comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::get_DocHostDoubleClickFlags

La DocHostDoubleClickFlags propriété spécifie l’opération qui doit avoir lieu en réponse à un double-clic.

STDMETHOD(get_DocHostDoubleClickFlags)(DWORD* pdwDocHostDoubleClickFlags);

Paramètres

pdwDocHostDoubleClickFlags
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise DOCHOSTUIDBLCLK_DEFAULT comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::get_DocHostFlags

La DocHostFlags propriété spécifie les fonctionnalités d’interface utilisateur de l’objet hôte.

STDMETHOD(get_DocHostFlags)(DWORD* pdwDocHostFlags);

Paramètres

pdwDocHostFlags
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise DOCHOSTUIFLAG_NO3DBORDER comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::get_Font

La Font propriété spécifie la police ambiante du conteneur.

STDMETHOD(get_Font)(IFontDisp** pFont);

Paramètres

pFont
[out] Adresse d’un pointeur d’interface IFontDisp utilisé pour recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise la police GUI par défaut ou la police système comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::get_ForeColor

La ForeColor propriété spécifie la couleur de premier plan ambiante du conteneur.

STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);

Paramètres

pclrForeground
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise la couleur de texte de la fenêtre système comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::get_LocaleID

La LocaleID propriété spécifie l’ID des paramètres régionaux ambiants du conteneur.

STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);

Paramètres

plcidLocaleID
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise les paramètres régionaux par défaut de l’utilisateur comme valeur par défaut de cette propriété.

Avec cette méthode, vous pouvez découvrir l’ID local ambiant, autrement dit, l’ID de paramètres régionaux du programme dans lequel votre contrôle est utilisé. Une fois que vous connaissez les paramètres régionaux, vous pouvez appeler du code pour charger des légende spécifiques aux paramètres régionaux, du texte du message d’erreur, etc. à partir d’un fichier de ressources ou d’une DLL satellite.

IAxWinAmbientDispatch ::get_MessageRéflexions

La MessageReflect propriété ambiante spécifie si le conteneur reflète les messages au contrôle hébergé.

STDMETHOD(get_MessageReflect)(VARIANT_BOOL* pbMessageReflect);

Paramètres

pbMessage Réflexions
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_TRUE comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::get_OptionKeyPath

La OptionKeyPath propriété spécifie le chemin d’accès de la clé de Registre aux paramètres utilisateur.

STDMETHOD(get_OptionKeyPath)(BSTR* pbstrOptionKeyPath);

Paramètres

pbstrOptionKeyPath
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

IAxWinAmbientDispatch ::get_ShowGrabHandles

La ShowGrabHandles propriété ambiante permet au contrôle de déterminer s’il doit se dessiner avec des poignées de saisie.

STDMETHOD(get_ShowGrabHandles)(VARIANT_BOOL* pbShowGrabHandles);

Paramètres

pbShowGrabHandles
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL retourne toujours VARIANT_FALSE comme valeur de cette propriété.

IAxWinAmbientDispatch ::get_ShowHatching

La ShowHatching propriété ambiante permet au contrôle de déterminer s’il doit se dessiner lui-même.

STDMETHOD(get_ShowHatching)(VARIANT_BOOL* pbShowHatching);

Paramètres

pbShowHatching
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL retourne toujours VARIANT_FALSE comme valeur de cette propriété.

IAxWinAmbientDispatch ::get_UserMode

La UserMode propriété spécifie le mode utilisateur ambiant du conteneur.

STDMETHOD(get_UserMode)(VARIANT_BOOL* pbUserMode);

Paramètres

pbUserMode
[out] Adresse d’une variable à recevoir la valeur actuelle de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_TRUE comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::p ut_AllowContextMenu

La AllowContextMenu propriété spécifie si le contrôle hébergé est autorisé à afficher son propre menu contextuel.

STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);

Paramètres

bAllowContextMenu
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_TRUE comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::p ut_AllowShowUI

La AllowShowUI propriété spécifie si le contrôle hébergé est autorisé à afficher sa propre interface utilisateur.

STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);

Paramètres

bAllowShowUI
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_FALSE comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::p ut_AllowWindowlessActivation

La AllowWindowlessActivation propriété spécifie si le conteneur autorise l’activation sans fenêtre.

STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);

Paramètres

bAllowWindowless
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_TRUE comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::p ut_BackColor

La BackColor propriété spécifie la couleur d’arrière-plan ambiante du conteneur.

STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);

Paramètres

clrBackground
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise COLOR_BTNFACE ou COLOR_WINDOW comme valeur par défaut de cette propriété (selon que le parent de la fenêtre hôte est un dialogue ou non).

IAxWinAmbientDispatch ::p ut_DisplayAsDefault

DisplayAsDefault est une propriété ambiante qui permet à un contrôle de déterminer s’il s’agit du contrôle par défaut.

STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);

Paramètres

bDisplayAsDefault
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_FALSE comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::p ut_DocHostDoubleClickFlags

La DocHostDoubleClickFlags propriété spécifie l’opération qui doit avoir lieu en réponse à un double-clic.

STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);

Paramètres

dwDocHostDoubleClickFlags
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise DOCHOSTUIDBLCLK_DEFAULT comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::p ut_DocHostFlags

La DocHostFlags propriété spécifie les fonctionnalités d’interface utilisateur de l’objet hôte.

STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);

Paramètres

dwDocHostFlags
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise DOCHOSTUIFLAG_NO3DBORDER comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::p ut_Font

La Font propriété spécifie la police ambiante du conteneur.

STDMETHOD(put_Font)(IFontDisp* pFont);

Paramètres

pFont
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise la police GUI par défaut ou la police système comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::p ut_ForeColor

La ForeColor propriété spécifie la couleur de premier plan ambiante du conteneur.

STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);

Paramètres

clrForeground
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise la couleur de texte de la fenêtre système comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::p ut_LocaleID

La LocaleID propriété spécifie l’ID des paramètres régionaux ambiants du conteneur.

STDMETHOD(put_LocaleID)(LCID lcidLocaleID);

Paramètres

lcidLocaleID
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise les paramètres régionaux par défaut de l’utilisateur comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::p ut_Message Réflexions

La MessageReflect propriété ambiante spécifie si le conteneur reflète les messages au contrôle hébergé.

STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);

Paramètres

bMessage Réflexions
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_TRUE comme valeur par défaut de cette propriété.

IAxWinAmbientDispatch ::p ut_OptionKeyPath

La OptionKeyPath propriété spécifie le chemin d’accès de la clé de Registre aux paramètres utilisateur.

STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);

Paramètres

bstrOptionKeyPath
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

IAxWinAmbientDispatch ::p ut_UserMode

La UserMode propriété spécifie le mode utilisateur ambiant du conteneur.

STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);

Paramètres

bUserMode
[in] Nouvelle valeur de cette propriété.

Valeur de retour

Valeur HRESULT standard.

Notes

L’implémentation de l’objet hôte ATL utilise VARIANT_TRUE comme valeur par défaut de cette propriété.

Voir aussi

IAxWinAmbientDispatchEx, interface
IAxWinHostWindow, interface
CAxWindow ::QueryHost
AtlAxGetHost