CToolTipCtrl::AddTool

[アーティクル]
02/21/2013

ツールヒントコントロールを持つツールを登録します。

BOOL AddTool(
   CWnd* pWnd,
   UINT nIDText,
   LPCRECT lpRectTool = NULL,
   UINT_PTR nIDTool = 0 
);
BOOL AddTool(
   CWnd* pWnd,
   LPCTSTR lpszText = LPSTR_TEXTCALLBACK,
   LPCRECT lpRectTool = NULL,
   UINT_PTR nIDTool = 0 
);

パラメーター

pWnd
ツールを含むウィンドウへのポインター。
nIDText
ツールのテキストを含む文字列リソースの ID。
lpRectTool
ツールの外接する四角形の座標を格納する RECT の構造体へのポインター。座標は pWndで識別されるペインのクライアント領域の左上隅を基準にします。
nIDTool
ツールの ID。
lpszText
ツールのテキストへのポインター。このパラメーターが値 LPSTR_TEXTCALLBACKが含まれている場合、TTN_NEEDTEXT の通知メッセージは pWnd が指すウィンドウの親に移動します。

戻り値

正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

lpRectTool と nIDTool のパラメーターの両方が有効である lpRectTool が null の場合、nIDTool を 0 にする必要があります。

ツールヒントコントロールは、複数のツールに関連付けることができます。カーソルがツールにある場合、ツールヒントに格納されている情報が表示されるように、ツールヒントコントロールを持つツールを登録するには、この関数を呼び出します。

[!メモ]

AddToolを使用してスタティックコントロールにツールヒントを設定できません。

使用例

CPropertySheet::GetTabControlの例を参照してください。

必要条件

ヘッダー: afxcmn.h

参照

関連項目

CToolTipCtrl クラス

CToolTipCtrl::DelTool