Win32 API 日本語リファレンス
ホーム › UI.Accessibility › IDockProvider

IDockProvider

COM
📘 Microsoft Learn (日本語) · English
IID159bc72c-4ad3-485e-9637-d7052edf0146継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ドッキング コンテナー内の要素へのアクセスを提供します。

解説(Remarks)

IDockProvider は、ドッキング コンテナーのプロパティや、ドッキング コンテナー内で現在のコントロールに隣接してドッキングされる可能性があるコントロールのプロパティを、一切公開しません。

コントロールは、現在の z オーダーに基づいて相互に相対的にドッキングされます。z オーダーの配置が高いほど、ドッキング コンテナーの指定された端から遠くに配置されます。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT SetDockPosition(DockPosition dockPosition)

この要素のドッキング位置を設定します。

dockPositionDockPositionin新しいドッキング位置。

戻り値

Type: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は、HRESULT エラー コードを返します。

解説(Remarks)

ドッキング コンテナーとは、ドッキング コンテナーの境界およびコンテナー内の他の要素を基準として、子要素を水平方向と垂直方向の両方に配置できるようにするコントロールです。

vtbl 4 HRESULT get_DockPosition(DockPosition* pRetVal)

この要素の現在のドッキング位置を示します。

pRetValDockPosition*out現在のドッキング位置を表す DockPosition を受け取る出力ポインタである。

解説(Remarks)

ドッキング コンテナーとは、ドッキング コンテナーの境界およびコンテナー内の他の要素を基準として、子要素を水平方向と垂直方向の両方に配置できるようにするコントロールです。

例

次の例は、DockPosition プロパティを返す方法を示しています。


    // dockPosition is a global variable of type DockPosition.

    HRESULT STDMETHODCALLTYPE BucketControl::get_DockPosition(DockPosition *pRetVal)
    {
        if (pRetVal == NULL)
        {
            return E_INVALIDARG;
        }
        *pRetVal = dockPosition;
        return S_OK;
    }
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IDockProvider "{159BC72C-4AD3-485E-9637-D7052EDF0146}"
#usecom global IDockProvider IID_IDockProvider "{}"
#comfunc global IDockProvider_SetDockPosition   3 int
#comfunc global IDockProvider_get_DockPosition  4 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。