IAgentCharacterEx::SetHelpModeOn

  • [アーティクル]

[Microsoft エージェントは Windows 7 の時点で非推奨となり、以降のバージョンの Windows では使用できない場合があります。]

HRESULT SetHelpModeOn(
   long bHelpModeOn  // help mode setting
);

文字の状況依存ヘルプ モードを オンに設定します。

  • 操作が成功したことを示すS_OKを返します。

bHelpModeOn

ヘルプ モード フラグ。 このパラメーターが True の場合、Microsoft エージェントは文字のヘルプ モードをオンにします。

このプロパティを True に設定すると、マウス ポインターは、文字の上または文字のポップアップ メニューの上に移動すると、状況依存のヘルプ イメージに変わります。 ユーザーが文字をクリックまたはドラッグするか、文字のポップアップ メニューの項目をクリックすると、サーバーによって IAgentNotifySinkEx::HelpComplete イベントがトリガーされ、ヘルプ モードが終了します。

ヘルプ モードでは、GetAutoPopupMenu プロパティが True を返さない限り、サーバーは Click、DragStart、DragComplete、Command イベントを送信しません。 その場合、サーバーは Click イベントを送信します (ヘルプ モードは終了しません)、ポップアップ メニューを表示できるようにマウスの右ボタンに対してのみ送信されます。

このプロパティは、クライアント アプリケーションによる 文字の使用にのみ適用されます。設定は、文字の他のクライアントやクライアント アプリケーションの他の文字には影響しません。

参照

IAgentCharacterEx::GetHelpModeOn,IAgentNotifySinkEx ::HelpComplete