注
Active Template Library (ATL) は引き続きサポートされています。 ただし、機能の追加やドキュメントの更新は行われません。
このインターフェイスは、ホストされるコントロールまたはコンテナーの特性を指定するためのメソッドを提供します。
重要
このクラスとそのメンバーは、Windows ランタイムで実行するアプリケーションで使用することはできません。
構文
interface IAxWinAmbientDispatch : IDispatch
メンバー
メソッド
| Name | 説明 |
|---|---|
| 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 プロパティは、コンテナーのアンビエント ロケール ID を指定します。 |
| 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 プロパティは、コンテナーのアンビエント ロケール ID を指定します。 |
| put_MessageReflect |
MessageReflect アンビエント プロパティは、コンテナーが、ホストされるコントロールへのメッセージを反映するかどうかを指定します。 |
| put_OptionKeyPath |
OptionKeyPath プロパティは、ユーザー設定へのレジストリ キー パスを指定します。 |
| put_UserMode |
UserMode プロパティは、コンテナーのアンビエント ユーザー モードを指定します。 |
解説
このインターフェイスは、ATL の ActiveX コントロールのホスティング オブジェクトによって公開されます。 このインターフェイスのメソッドを呼び出して、ホストされるコントロールで使用できるアンビエント プロパティを設定するか、コンテナーの動作の他の側面を指定します。
IAxWinAmbientDispatch から提供されるプロパティを補完するには、IAxWinAmbientDispatchEx を使用します。
AxHost では、コードを含む typelib から IAxWinAmbientDispatch と IAxWinAmbientDispatchEx に関する型情報を読み込もうとします。
ATL90.dll にリンクしている場合、AXHost は、DLL 内の typelib から型情報を読み込みます。
詳細については、「ATL AXHost を使用して ActiveX コントロールをホストする」を参照してください。
要件
このインターフェイスの定義は、次の表に示すように、多くの形式で使用できます。
| 定義の種類 | ファイル |
|---|---|
| IDL | atliface.idl |
| タイプ ライブラリ | ATL.dll |
| C++ | atliface.h (ATLBase.h にも含まれる) |
IAxWinAmbientDispatch::get_AllowContextMenu
AllowContextMenu プロパティは、ホストされるコントロールが独自のコンテキスト メニューを表示できるかどうかを指定します。
STDMETHOD(get_AllowContextMenu)(VARIANT_BOOL* pbAllowContextMenu);
パラメーター
pbAllowContextMenu
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_TRUE が使用されます。
IAxWinAmbientDispatch::get_AllowShowUI
AllowShowUI プロパティは、ホストされるコントロールが独自のユーザー インターフェイスを表示できるかどうかを指定します。
STDMETHOD(get_AllowShowUI)(VARIANT_BOOL* pbAllowShowUI);
パラメーター
pbAllowShowUI
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_FALSE が使用されます。
IAxWinAmbientDispatch::get_AllowWindowlessActivation
AllowWindowlessActivation プロパティは、コンテナーでウィンドウなしのアクティブ化を許可するかどうかを指定します。
STDMETHOD(get_AllowWindowlessActivation)(VARIANT_BOOL* pbAllowWindowless);
パラメーター
pbAllowWindowless
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_TRUE が使用されます。
IAxWinAmbientDispatch::get_BackColor
BackColor プロパティは、コンテナーのアンビエント背景色を指定します。
STDMETHOD(get_BackColor)(OLE_COLOR* pclrBackground);
パラメーター
pclrBackground
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として COLOR_BTNFACE または COLOR_WINDOW が使用されます (ホスト ウィンドウの親がダイアログかどうかによって異なります)。
IAxWinAmbientDispatch::get_DisplayAsDefault
DisplayAsDefault は、コントロールで、既定のコントロールであるかを確認できるようにするアンビエント プロパティです。
STDMETHOD(get_DisplayAsDefault)(VARIANT_BOOL* pbDisplayAsDefault);
パラメーター
pbDisplayAsDefault
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_FALSE が使用されます。
IAxWinAmbientDispatch::get_DocHostDoubleClickFlags
DocHostDoubleClickFlags プロパティは、ダブルクリックに応答して実行する必要がある操作を指定します。
STDMETHOD(get_DocHostDoubleClickFlags)(DWORD* pdwDocHostDoubleClickFlags);
パラメーター
pdwDocHostDoubleClickFlags
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として DOCHOSTUIDBLCLK_DEFAULT が使用されます。
IAxWinAmbientDispatch::get_DocHostFlags
DocHostFlags プロパティは、ホスト オブジェクトのユーザー インターフェイス機能を指定します。
STDMETHOD(get_DocHostFlags)(DWORD* pdwDocHostFlags);
パラメーター
pdwDocHostFlags
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として DOCHOSTUIFLAG_NO3DBORDER が使用されます。
IAxWinAmbientDispatch::get_Font
Font プロパティは、コンテナーのアンビエント フォントを指定します。
STDMETHOD(get_Font)(IFontDisp** pFont);
パラメーター
pFont
[出力] このプロパティの現在値を受け取るために使用される IFontDisp インターフェイス ポインターのアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として既定の GUI フォントまたはシステム フォントが使用されます。
IAxWinAmbientDispatch::get_ForeColor
ForeColor プロパティは、コンテナーのアンビエント前景色を指定します。
STDMETHOD(get_ForeColor)(OLE_COLOR* pclrForeground);
パラメーター
pclrForeground
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値としてシステム ウィンドウのテキストの色が使用されます。
IAxWinAmbientDispatch::get_LocaleID
LocaleID プロパティは、コンテナーのアンビエント ロケール ID を指定します。
STDMETHOD(get_LocaleID)(LCID* plcidLocaleID);
パラメーター
plcidLocaleID
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値としてユーザーの既定のロケールが使用されます。
このメソッドを使用すると、アンビエント LocalID、つまり、コントロールが使用されているプログラムの LocaleID を検出できます。 LocaleID がわかると、リソース ファイルまたはサテライト DLL からロケール固有のキャプションやエラー メッセージ テキストなどを読み込むコードを呼び出すことができます。
IAxWinAmbientDispatch::get_MessageReflect
MessageReflect アンビエント プロパティは、コンテナーが、ホストされるコントロールへのメッセージを反映するかどうかを指定します。
STDMETHOD(get_MessageReflect)(VARIANT_BOOL* pbMessageReflect);
パラメーター
pbMessageReflect
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_TRUE が使用されます。
IAxWinAmbientDispatch::get_OptionKeyPath
OptionKeyPath プロパティは、ユーザー設定へのレジストリ キー パスを指定します。
STDMETHOD(get_OptionKeyPath)(BSTR* pbstrOptionKeyPath);
パラメーター
pbstrOptionKeyPath
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
IAxWinAmbientDispatch::get_ShowGrabHandles
ShowGrabHandles アンビエント プロパティを使用すると、コントロールがグラブ ハンドルを使用してそれ自体を描画する必要があるかどうかを判断できます。
STDMETHOD(get_ShowGrabHandles)(VARIANT_BOOL* pbShowGrabHandles);
パラメーター
pbShowGrabHandles
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの値として常に VARIANT_FALSE が返されます。
IAxWinAmbientDispatch::get_ShowHatching
ShowHatching アンビエント プロパティは、ハッチングを使ってコントロール自体を描画する必要があるかどうかをコントロールで確認できるようにします。
STDMETHOD(get_ShowHatching)(VARIANT_BOOL* pbShowHatching);
パラメーター
pbShowHatching
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの値として常に VARIANT_FALSE が返されます。
IAxWinAmbientDispatch::get_UserMode
UserMode プロパティは、コンテナーのアンビエント ユーザー モードを指定します。
STDMETHOD(get_UserMode)(VARIANT_BOOL* pbUserMode);
パラメーター
pbUserMode
[出力] このプロパティの現在の値を受け取る変数のアドレス。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_TRUE が使用されます。
IAxWinAmbientDispatch::put_AllowContextMenu
AllowContextMenu プロパティは、ホストされるコントロールが独自のコンテキスト メニューを表示できるかどうかを指定します。
STDMETHOD(put_AllowContextMenu)(VARIANT_BOOL bAllowContextMenu);
パラメーター
bAllowContextMenu
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_TRUE が使用されます。
IAxWinAmbientDispatch::put_AllowShowUI
AllowShowUI プロパティは、ホストされるコントロールが独自のユーザー インターフェイスを表示できるかどうかを指定します。
STDMETHOD(put_AllowShowUI)(VARIANT_BOOL bAllowShowUI);
パラメーター
bAllowShowUI
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_FALSE が使用されます。
IAxWinAmbientDispatch::put_AllowWindowlessActivation
AllowWindowlessActivation プロパティは、コンテナーでウィンドウなしのアクティブ化を許可するかどうかを指定します。
STDMETHOD(put_AllowWindowlessActivation)(VARIANT_BOOL bAllowWindowless);
パラメーター
bAllowWindowless
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_TRUE が使用されます。
IAxWinAmbientDispatch::put_BackColor
BackColor プロパティは、コンテナーのアンビエント背景色を指定します。
STDMETHOD(put_BackColor)(OLE_COLOR clrBackground);
パラメーター
clrBackground
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として COLOR_BTNFACE または COLOR_WINDOW が使用されます (ホスト ウィンドウの親がダイアログかどうかによって異なります)。
IAxWinAmbientDispatch::put_DisplayAsDefault
DisplayAsDefault は、コントロールで、既定のコントロールであるかを確認できるようにするアンビエント プロパティです。
STDMETHOD(put_DisplayAsDefault)(VARIANT_BOOL bDisplayAsDefault);
パラメーター
bDisplayAsDefault
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_FALSE が使用されます。
IAxWinAmbientDispatch::put_DocHostDoubleClickFlags
DocHostDoubleClickFlags プロパティは、ダブルクリックに応答して実行する必要がある操作を指定します。
STDMETHOD(put_DocHostDoubleClickFlags)(DWORD dwDocHostDoubleClickFlags);
パラメーター
dwDocHostDoubleClickFlags
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として DOCHOSTUIDBLCLK_DEFAULT が使用されます。
IAxWinAmbientDispatch::put_DocHostFlags
DocHostFlags プロパティは、ホスト オブジェクトのユーザー インターフェイス機能を指定します。
STDMETHOD(put_DocHostFlags)(DWORD dwDocHostFlags);
パラメーター
dwDocHostFlags
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として DOCHOSTUIFLAG_NO3DBORDER が使用されます。
IAxWinAmbientDispatch::put_Font
Font プロパティは、コンテナーのアンビエント フォントを指定します。
STDMETHOD(put_Font)(IFontDisp* pFont);
パラメーター
pFont
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として既定の GUI フォントまたはシステム フォントが使用されます。
IAxWinAmbientDispatch::put_ForeColor
ForeColor プロパティは、コンテナーのアンビエント前景色を指定します。
STDMETHOD(put_ForeColor)(OLE_COLOR clrForeground);
パラメーター
clrForeground
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値としてシステム ウィンドウのテキストの色が使用されます。
IAxWinAmbientDispatch::put_LocaleID
LocaleID プロパティは、コンテナーのアンビエント ロケール ID を指定します。
STDMETHOD(put_LocaleID)(LCID lcidLocaleID);
パラメーター
lcidLocaleID
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値としてユーザーの既定のロケールが使用されます。
IAxWinAmbientDispatch::put_MessageReflect
MessageReflect アンビエント プロパティは、コンテナーが、ホストされるコントロールへのメッセージを反映するかどうかを指定します。
STDMETHOD(put_MessageReflect)(VARIANT_BOOL bMessageReflect);
パラメーター
bMessageReflect
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_TRUE が使用されます。
IAxWinAmbientDispatch::put_OptionKeyPath
OptionKeyPath プロパティは、ユーザー設定へのレジストリ キー パスを指定します。
STDMETHOD(put_OptionKeyPath)(BSTR bstrOptionKeyPath);
パラメーター
bstrOptionKeyPath
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
IAxWinAmbientDispatch::put_UserMode
UserMode プロパティは、コンテナーのアンビエント ユーザー モードを指定します。
STDMETHOD(put_UserMode)(VARIANT_BOOL bUserMode);
パラメーター
bUserMode
[入力] このプロパティの新しい値。
戻り値
標準の HRESULT 値。
解説
ATL ホスト オブジェクトの実装で、このプロパティの既定値として VARIANT_TRUE が使用されます。
関連項目
IAxWinAmbientDispatchEx インターフェイス
IAxWinHostWindow インターフェイス
CAxWindow::QueryHost
AtlAxGetHost