Интерфейс IAxWinAmbientDispatch

Этот интерфейс предоставляет методы для указания характеристик размещенного элемента управления или контейнера.

Синтаксис

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 задает идентификатор внешнего языкового стандарта контейнера.
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 задает идентификатор внешнего языкового стандарта контейнера.
put_MessageReflect	Свойство MessageReflect окружения указывает, будет ли контейнер отражать сообщения размещенного элемента управления.
put_OptionKeyPath	Свойство OptionKeyPath указывает путь к разделу реестра к параметрам пользователя.
put_UserMode	Свойство UserMode задает внешний пользовательский режим контейнера.

Замечания

Этот интерфейс предоставляется объектами управления ActiveX atL. Вызовите методы этого интерфейса, чтобы задать внешние свойства, доступные для размещенного элемента управления, или указать другие аспекты поведения контейнера. Чтобы дополнить свойства, предоставляемые IAxWinAmbientDispatch, используйте IAxWinAmbientDispatchEx.

AxHost попытается загрузить сведения о IAxWinAmbientDispatch типе и IAxWinAmbientDispatchEx из typelib, содержащего код.

Если вы связываетесь с ATL90.dll, AXHost загружает сведения о типе из typelib в библиотеке DLL.

Дополнительные сведения см. в разделе "Размещение элементов ActiveX Controls с помощью ATL AXHost ".

Требования

Определение этого интерфейса доступно в нескольких формах, как показано в таблице ниже.

Тип определения	Файлы
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 использует шрифт графического интерфейса по умолчанию или системный шрифт в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::get_ForeColor

Свойство ForeColor задает внешний цвет переднего плана контейнера.

STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);

Параметры

pclrForeground
[out] Адрес переменной для получения текущего значения этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует цвет текста системного окна в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::get_LocaleID

Свойство LocaleID задает идентификатор внешнего языкового стандарта контейнера.

STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);

Параметры

plcidLocaleID
[out] Адрес переменной для получения текущего значения этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует языковой стандарт пользователя по умолчанию в качестве значения по умолчанию этого свойства.

С помощью этого метода можно обнаружить ambient 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::p ut_AllowContextMenu

Свойство AllowContextMenu указывает, разрешено ли размещенное управление отображать собственное контекстное меню.

STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);

Параметры

bAllowContextMenu
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует VARIANT_TRUE в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::p ut_AllowShowUI

Свойство AllowShowUI указывает, разрешено ли размещенное элементу управления отображать собственный пользовательский интерфейс.

STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);

Параметры

bAllowShowUI
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует VARIANT_FALSE в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::p ut_AllowWindowlessActivation

Свойство AllowWindowlessActivation указывает, будет ли контейнер разрешать активацию без окон.

STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);

Параметры

bAllowWindowless
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует VARIANT_TRUE в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::p ut_BackColor

Свойство BackColor указывает внешний цвет фона контейнера.

STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);

Параметры

clrBackground
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует COLOR_BTNFACE или COLOR_WINDOW в качестве значения по умолчанию этого свойства (в зависимости от того, является ли родительский элемент окна узла диалогом или нет).

IAxWinAmbientDispatch::p ut_DisplayAsDefault

DisplayAsDefault — это внешнее свойство, позволяющее элементу управления определить, является ли он элементом управления по умолчанию.

STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);

Параметры

bDisplayAsDefault
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует VARIANT_FALSE в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::p ut_DocHostDoubleClickFlags

Свойство DocHostDoubleClickFlags указывает операцию, которая должна выполняться в ответ на двойной щелчок.

STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);

Параметры

dwDocHostDoubleClickFlags
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует DOCHOSTUIDBLCLK_DEFAULT в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::p ut_DocHostFlags

Свойство DocHostFlags задает возможности пользовательского интерфейса объекта узла.

STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);

Параметры

dwDocHostFlags
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует DOCHOSTUIFLAG_NO3DBORDER в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::p ut_Font

Свойство Font задает внешний шрифт контейнера.

STDMETHOD(put_Font)(IFontDisp* pFont);

Параметры

pFont
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует шрифт графического интерфейса по умолчанию или системный шрифт в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::p ut_ForeColor

Свойство ForeColor задает внешний цвет переднего плана контейнера.

STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);

Параметры

clrForeground
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует цвет текста системного окна в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::p ut_LocaleID

Свойство LocaleID задает идентификатор внешнего языкового стандарта контейнера.

STDMETHOD(put_LocaleID)(LCID lcidLocaleID);

Параметры

lcidLocaleID
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует языковой стандарт пользователя по умолчанию в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::p ut_MessageReflect

Свойство MessageReflect окружения указывает, будет ли контейнер отражать сообщения размещенного элемента управления.

STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);

Параметры

bMessageReflect
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует VARIANT_TRUE в качестве значения по умолчанию этого свойства.

IAxWinAmbientDispatch::p ut_OptionKeyPath

Свойство OptionKeyPath указывает путь к разделу реестра к параметрам пользователя.

STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);

Параметры

bstrOptionKeyPath
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

IAxWinAmbientDispatch::p ut_UserMode

Свойство UserMode задает внешний пользовательский режим контейнера.

STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);

Параметры

bUserMode
[in] Новое значение этого свойства.

Возвращаемое значение

Стандартное значение HRESULT.

Замечания

Реализация объекта узла ATL использует VARIANT_TRUE в качестве значения по умолчанию этого свойства.

См. также

Интерфейс IAxWinAmbientDispatchEx
Интерфейс IAxWinHostWindow
CAxWindow::QueryHost
AtlAxGetHost