Interfejs IAxWinAmbientDispatch

Ten interfejs udostępnia metody określania właściwości hostowanej kontrolki lub kontenera.

Ważne

Tej klasy i jej składowych nie można używać w aplikacjach wykonywanych w środowisko wykonawcze systemu Windows.

Składnia

interface IAxWinAmbientDispatch : IDispatch

Elementy członkowskie

Metody

Nazwa/nazwisko	opis
get_AllowContextMenu	Właściwość określa, czy hostowana AllowContextMenu kontrolka może wyświetlać własne menu kontekstowe.
get_AllowShowUI	Właściwość AllowShowUI określa, czy hostowana kontrolka może wyświetlać własny interfejs użytkownika.
get_AllowWindowlessActivation	Właściwość AllowWindowlessActivation określa, czy kontener zezwoli na aktywację bez okien.
get_BackColor	Właściwość BackColor określa kolor tła otoczenia kontenera.
get_DisplayAsDefault	DisplayAsDefault to właściwość otoczenia, która umożliwia kontrolce sprawdzanie, czy jest to domyślna kontrolka.
get_DocHostDoubleClickFlags	Właściwość DocHostDoubleClickFlags określa operację, która powinna odbywać się w odpowiedzi na dwukrotne kliknięcie.
get_DocHostFlags	Właściwość DocHostFlags określa możliwości interfejsu użytkownika obiektu hosta.
get_Font	Właściwość Font określa czcionkę otoczenia kontenera.
get_ForeColor	Właściwość ForeColor określa kolor otoczenia pierwszego planu kontenera.
get_LocaleID	Właściwość LocaleID określa identyfikator ustawień regionalnych otoczenia kontenera.
get_MessageReflect	Właściwość MessageReflect otoczenia określa, czy kontener będzie odzwierciedlać komunikaty do hostowanej kontrolki.
get_OptionKeyPath	Właściwość OptionKeyPath określa ścieżkę klucza rejestru do ustawień użytkownika.
get_ShowGrabHandles	Właściwość ShowGrabHandles otoczenia pozwala kontrolce dowiedzieć się, czy powinien rysować się z uchwytami chwytania.
get_ShowHatching	Właściwość ShowHatching otoczenia pozwala kontrolce dowiedzieć się, czy powinien narysować się wykluł.
get_UserMode	Właściwość UserMode określa otoczenia trybu użytkownika kontenera.
put_AllowContextMenu	Właściwość określa, czy hostowana AllowContextMenu kontrolka może wyświetlać własne menu kontekstowe.
put_AllowShowUI	Właściwość AllowShowUI określa, czy hostowana kontrolka może wyświetlać własny interfejs użytkownika.
put_AllowWindowlessActivation	Właściwość AllowWindowlessActivation określa, czy kontener zezwoli na aktywację bez okien.
put_BackColor	Właściwość BackColor określa kolor tła otoczenia kontenera.
put_DisplayAsDefault	DisplayAsDefault to właściwość otoczenia, która umożliwia kontrolce sprawdzanie, czy jest to domyślna kontrolka.
put_DocHostDoubleClickFlags	Właściwość DocHostDoubleClickFlags określa operację, która powinna odbywać się w odpowiedzi na dwukrotne kliknięcie.
put_DocHostFlags	Właściwość DocHostFlags określa możliwości interfejsu użytkownika obiektu hosta.
put_Font	Właściwość Font określa czcionkę otoczenia kontenera.
put_ForeColor	Właściwość ForeColor określa kolor otoczenia pierwszego planu kontenera.
put_LocaleID	Właściwość LocaleID określa identyfikator ustawień regionalnych otoczenia kontenera.
put_MessageReflect	Właściwość MessageReflect otoczenia określa, czy kontener będzie odzwierciedlać komunikaty do hostowanej kontrolki.
put_OptionKeyPath	Właściwość OptionKeyPath określa ścieżkę klucza rejestru do ustawień użytkownika.
put_UserMode	Właściwość UserMode określa otoczenia trybu użytkownika kontenera.

Uwagi

Ten interfejs jest udostępniany przez obiekty hostowania kontrolek ActiveX atL. Wywołaj metody w tym interfejsie, aby ustawić właściwości otoczenia dostępne dla hostowanej kontrolki lub określić inne aspekty zachowania kontenera. Aby uzupełnić właściwości dostarczane przez IAxWinAmbientDispatchusługę , użyj elementu IAxWinAmbientDispatchEx.

AxHost Program podejmie próbę załadowania informacji o IAxWinAmbientDispatch typie i IAxWinAmbientDispatchEx z biblioteki typelib zawierającej kod.

Jeśli łączysz się z ATL90.dll, axHost załaduje informacje o typie z biblioteki typelib w dll.

Aby uzyskać więcej informacji, zobacz Hostowanie kontrolek ActiveX przy użyciu atl AXHost .

Wymagania

Definicja tego interfejsu jest dostępna w wielu formularzach, jak pokazano w poniższej tabeli.

Typ definicji	Plik
IDL	atliface.idl
Biblioteka typów	ATL.dll
C++	atliface.h (również w atLBase.h)

IAxWinAmbientDispatch::get_AllowContextMenu

Właściwość określa, czy hostowana AllowContextMenu kontrolka może wyświetlać własne menu kontekstowe.

STDMETHOD(get_AllowContextMenu)(VARIANT_BOOL* pbAllowContextMenu);

Parametry

pbAllowContextMenu
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_TRUE jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::get_AllowShowUI

Właściwość AllowShowUI określa, czy hostowana kontrolka może wyświetlać własny interfejs użytkownika.

STDMETHOD(get_AllowShowUI)(VARIANT_BOOL* pbAllowShowUI);

Parametry

pbAllowShowUI
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_FALSE jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::get_AllowWindowlessActivation

Właściwość AllowWindowlessActivation określa, czy kontener zezwoli na aktywację bez okien.

STDMETHOD(get_AllowWindowlessActivation)(VARIANT_BOOL* pbAllowWindowless);

Parametry

pbAllowWindowless
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_TRUE jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::get_BackColor

Właściwość BackColor określa kolor tła otoczenia kontenera.

STDMETHOD(get_BackColor)(OLE_COLOR* pclrBackground);

Parametry

pclrBackground
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa COLOR_BTNFACE lub COLOR_WINDOW jako wartości domyślnej tej właściwości (w zależności od tego, czy element nadrzędny okna hosta jest oknem dialogowym, czy nie).

IAxWinAmbientDispatch::get_DisplayAsDefault

DisplayAsDefault to właściwość otoczenia, która umożliwia kontrolce sprawdzanie, czy jest to domyślna kontrolka.

STDMETHOD(get_DisplayAsDefault)(VARIANT_BOOL* pbDisplayAsDefault);

Parametry

pbDisplayAsDefault
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_FALSE jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::get_DocHostDoubleClickFlags

Właściwość DocHostDoubleClickFlags określa operację, która powinna odbywać się w odpowiedzi na dwukrotne kliknięcie.

STDMETHOD(get_DocHostDoubleClickFlags)(DWORD* pdwDocHostDoubleClickFlags);

Parametry

pdwDocHostDoubleClickFlags
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa DOCHOSTUIDBLCLK_DEFAULT jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::get_DocHostFlags

Właściwość DocHostFlags określa możliwości interfejsu użytkownika obiektu hosta.

STDMETHOD(get_DocHostFlags)(DWORD* pdwDocHostFlags);

Parametry

pdwDocHostFlags
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa DOCHOSTUIFLAG_NO3DBORDER jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::get_Font

Właściwość Font określa czcionkę otoczenia kontenera.

STDMETHOD(get_Font)(IFontDisp** pFont);

Parametry

pFont
[out] Adres wskaźnika interfejsu IFontDisp używanego do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa domyślnej czcionki graficznego interfejsu użytkownika lub czcionki systemowej jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::get_ForeColor

Właściwość ForeColor określa kolor otoczenia pierwszego planu kontenera.

STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);

Parametry

pclrForeground
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa koloru tekstu okna systemowego jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::get_LocaleID

Właściwość LocaleID określa identyfikator ustawień regionalnych otoczenia kontenera.

STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);

Parametry

plcidLocaleID
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa domyślnych ustawień regionalnych użytkownika jako wartości domyślnej tej właściwości.

Za pomocą tej metody można odnaleźć identyfikator LocalID otoczenia, czyli localeID programu, w którym jest używana kontrolka. Gdy znasz identyfikator LocaleID, możesz wywołać kod, aby załadować transkrypty specyficzne dla ustawień regionalnych, tekst komunikatu o błędzie i tak dalej z pliku zasobu lub biblioteki DLL satelitarnej.

IAxWinAmbientDispatch::get_MessageReflect

Właściwość MessageReflect otoczenia określa, czy kontener będzie odzwierciedlać komunikaty do hostowanej kontrolki.

STDMETHOD(get_MessageReflect)(VARIANT_BOOL* pbMessageReflect);

Parametry

pbMessageReflect
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_TRUE jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::get_OptionKeyPath

Właściwość OptionKeyPath określa ścieżkę klucza rejestru do ustawień użytkownika.

STDMETHOD(get_OptionKeyPath)(BSTR* pbstrOptionKeyPath);

Parametry

pbstrOptionKeyPath
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

IAxWinAmbientDispatch::get_ShowGrabHandles

Właściwość ShowGrabHandles otoczenia pozwala kontrolce dowiedzieć się, czy powinien rysować się z uchwytami chwytania.

STDMETHOD(get_ShowGrabHandles)(VARIANT_BOOL* pbShowGrabHandles);

Parametry

pbShowGrabHandles
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL zawsze zwraca VARIANT_FALSE jako wartość tej właściwości.

IAxWinAmbientDispatch::get_ShowHatching

Właściwość ShowHatching otoczenia pozwala kontrolce dowiedzieć się, czy powinien narysować się wykluł.

STDMETHOD(get_ShowHatching)(VARIANT_BOOL* pbShowHatching);

Parametry

pbShowHatching
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL zawsze zwraca VARIANT_FALSE jako wartość tej właściwości.

IAxWinAmbientDispatch::get_UserMode

Właściwość UserMode określa otoczenia trybu użytkownika kontenera.

STDMETHOD(get_UserMode)(VARIANT_BOOL* pbUserMode);

Parametry

pbUserMode
[out] Adres zmiennej do odbierania bieżącej wartości tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_TRUE jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::p ut_AllowContextMenu

Właściwość określa, czy hostowana AllowContextMenu kontrolka może wyświetlać własne menu kontekstowe.

STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);

Parametry

bAllowContextMenu
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_TRUE jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::p ut_AllowShowUI

Właściwość AllowShowUI określa, czy hostowana kontrolka może wyświetlać własny interfejs użytkownika.

STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);

Parametry

bAllowShowUI
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_FALSE jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::p ut_AllowWindowlessActivation

Właściwość AllowWindowlessActivation określa, czy kontener zezwoli na aktywację bez okien.

STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);

Parametry

bAllowWindowless
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_TRUE jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::p ut_BackColor

Właściwość BackColor określa kolor tła otoczenia kontenera.

STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);

Parametry

clrBackground
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa COLOR_BTNFACE lub COLOR_WINDOW jako wartości domyślnej tej właściwości (w zależności od tego, czy element nadrzędny okna hosta jest oknem dialogowym, czy nie).

IAxWinAmbientDispatch::p ut_DisplayAsDefault

DisplayAsDefault to właściwość otoczenia, która umożliwia kontrolce sprawdzanie, czy jest to domyślna kontrolka.

STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);

Parametry

bDisplayAsDefault
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_FALSE jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::p ut_DocHostDoubleClickFlags

Właściwość DocHostDoubleClickFlags określa operację, która powinna odbywać się w odpowiedzi na dwukrotne kliknięcie.

STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);

Parametry

dwDocHostDoubleClickFlags
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa DOCHOSTUIDBLCLK_DEFAULT jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::p ut_DocHostFlags

Właściwość DocHostFlags określa możliwości interfejsu użytkownika obiektu hosta.

STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);

Parametry

dwDocHostFlags
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa DOCHOSTUIFLAG_NO3DBORDER jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::p ut_Font

Właściwość Font określa czcionkę otoczenia kontenera.

STDMETHOD(put_Font)(IFontDisp* pFont);

Parametry

pFont
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa domyślnej czcionki graficznego interfejsu użytkownika lub czcionki systemowej jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::p ut_ForeColor

Właściwość ForeColor określa kolor otoczenia pierwszego planu kontenera.

STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);

Parametry

clrForeground
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa koloru tekstu okna systemowego jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::p ut_LocaleID

Właściwość LocaleID określa identyfikator ustawień regionalnych otoczenia kontenera.

STDMETHOD(put_LocaleID)(LCID lcidLocaleID);

Parametry

lcidLocaleID
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa domyślnych ustawień regionalnych użytkownika jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::p ut_MessageReflect

Właściwość MessageReflect otoczenia określa, czy kontener będzie odzwierciedlać komunikaty do hostowanej kontrolki.

STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);

Parametry

bMessageReflect
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_TRUE jako wartości domyślnej tej właściwości.

IAxWinAmbientDispatch::p ut_OptionKeyPath

Właściwość OptionKeyPath określa ścieżkę klucza rejestru do ustawień użytkownika.

STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);

Parametry

bstrOptionKeyPath
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

IAxWinAmbientDispatch::p ut_UserMode

Właściwość UserMode określa otoczenia trybu użytkownika kontenera.

STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);

Parametry

bUserMode
[in] Nowa wartość tej właściwości.

Wartość zwracana

Standardowa wartość HRESULT.

Uwagi

Implementacja obiektu hosta ATL używa VARIANT_TRUE jako wartości domyślnej tej właściwości.

Zobacz też

Interfejs IAxWinAmbientDispatchEx
Interfejs IAxWinHostWindow
CAxWindow::QueryHost
AtlAxGetHost