ホーム › UI.Ribbon › IUICommandHandler

IUICommandHandler

COM

IID75ae0a2d-dc03-4c9f-8883-069660d0beb6継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IUICommandHandler インターフェイスはアプリケーション側で実装し、Command 情報を収集するためのメソッドと、Windows Ribbon フレームワークからの Command イベントを処理するためのメソッドを定義します。

解説(Remarks)

View 内の各 Command について、Ribbon フレームワークはホストアプリケーション側に対応する Command ハンドラーを必要とします。新規のハンドラー、または既存のハンドラーを、IUIApplication::OnCreateUICommand 通知メソッドを通じて Command にバインドする必要があります。

任意の数の Command を 1 つの Command ハンドラーにバインドできます。

Command ハンドラーには 2 つの役割があります。プロパティ更新要求に応答することと、バインドされている Command の実行イベントに応答することです。

メソッド 2

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

vtbl 3 HRESULT Execute(DWORD commandId, UI_EXECUTIONVERB verb, PROPERTYKEY* key, PROPVARIANT* currentValue, IUISimplePropertySet* commandExecutionProperties)

Command ハンドラーにバインドされた Command の実行イベントに応答します。

commandId	DWORD	in	Command の ID です。Markup リソースファイルで指定されます。
verb	UI_EXECUTIONVERB	in	ユーザーによって開始された UI_EXECUTIONVERB (アクション) です。
key	PROPERTYKEY*	inoptional	値が変更された Property Key へのポインターです。このパラメーターには NULL を指定できます。
currentValue	PROPVARIANT*	inoptional	key の現在の値へのポインターです。このパラメーターには NULL を指定できます。
commandExecutionProperties	IUISimplePropertySet*	inoptional	画面座標やリストアイテムのインデックスなど、Command の状態プロパティとプロパティ値を保持する IUISimplePropertySet オブジェクトへのポインターです。このパラメーターには NULL を指定できます。

戻り値

型: HRESULT

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

解説(Remarks)

View 内の各 Command は、ホストアプリケーション内の新規または既存の Command ハンドラーにバインドする必要があります。

vtbl 4 HRESULT UpdateProperty(DWORD commandId, PROPERTYKEY* key, PROPVARIANT* currentValue, PROPVARIANT* newValue)

Windows Ribbon フレームワークからのプロパティ更新要求に応答します。

commandId	DWORD	in	Command の ID です。Markup リソースファイルで指定されます。
key	PROPERTYKEY*	in	更新する Property Key です。
currentValue	PROPVARIANT*	inoptional	key の現在の値へのポインターです。このパラメーターには NULL を指定できます。
newValue	PROPVARIANT*	out	このメソッドから制御が戻るとき、 key の新しい値へのポインターが格納されます。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドは、Ribbon フレームワークへの後続の呼び出しを行う前に、制御を返せるようにする必要があります。

UI_PKEY_Enabled や UI_PKEY_Label などの Command プロパティの値は、SetUICommandProperty または InvalidateUICommand の呼び出しによって設定されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUICommandHandler "{75AE0A2D-DC03-4C9F-8883-069660D0BEB6}"
#usecom global IUICommandHandler IID_IUICommandHandler "{}"
#comfunc global IUICommandHandler_Execute         3 int,int,var,var,sptr
#comfunc global IUICommandHandler_UpdateProperty  4 int,var,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IUICommandHandler "{75AE0A2D-DC03-4C9F-8883-069660D0BEB6}"
#usecom global IUICommandHandler IID_IUICommandHandler "{}"
#comfunc global IUICommandHandler_Execute         3 int,int,sptr,sptr,sptr
#comfunc global IUICommandHandler_UpdateProperty  4 int,sptr,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。