IAgentCharacterEx::GetHelpModeOn
[Microsoft エージェントは Windows 7 の時点で非推奨となり、以降のバージョンの Windows では使用できない可能性があります。]
HRESULT GetHelpModeOn(
long * pbHelpModeOn // address of help mode setting
);
コンテキスト依存のヘルプ モードが文字に対してオンになっているかどうかを取得します。
- 操作が成功したことを示すS_OKを返します。
-
pbHelpModeOnを する
-
文字に対してヘルプ モードがオンの場合は True を受け取り、そうでない場合は false 変数のアドレス。
このプロパティを Trueに設定すると、マウス ポインターは、文字の上または文字のポップアップ メニューの上に移動すると、状況依存のヘルプ イメージに変わります。 ユーザーが文字をクリックまたはドラッグするか、文字のポップアップ メニュー内の項目をクリックすると、サーバーは IAgentNotifySinkEx::HelpComplete イベントをトリガーし、ヘルプ モードを終了します。
ヘルプ モードでは、サーバーは IAgentNotifySink::Click、IAgentNotifySink::D ragStart、IAgentNotifySink::D ragComplete、および IAgentNotifySink::Commandイベントを送信しません。 GetAutoPopupMenuプロパティtrue 返す場合を除く。 その場合、サーバーは IAgentNotifySink::Click イベントを送信します (ヘルプ モードは終了しません)。ただし、マウスの右ボタンでのみポップアップ メニューを表示できます。
このプロパティは、クライアント アプリケーションによる文字の使用にのみ適用されます。この設定は、文字の他のクライアントやクライアント アプリケーションの他の文字には影響しません。
関連項目
IAgentCharacterEx::SetHelpModeOn