Partager via

CTooltipManager::CreateToolTip

  • Article

Creates a tooltip control.

static BOOL CreateToolTip(
   CToolTipCtrl*& pToolTip,
   CWnd* pWndParent,
   UINT nType 
);

Parameters

  • [out] pToolTip
    A reference to a tooltip pointer. It is set to point to the newly created tooltip when the function returns.

  • [in] pWndParent
    Parent of the tooltip.

  • [in] nType
    Type of the tooltip.

Return Value

Nonzero if a tooltip has been created successfully.

Remarks

You must call CTooltipManager::DeleteToolTip to delete the tooltip control that is passed back in pToolTip.

The CTooltipManager Class sets the visual display parameters of each tooltip it creates based on the tooltip type that nType specifies. To change the parameters for one or more tooltip types, call CTooltipManager::SetTooltipParams.

Valid tooltip types are listed in the following table:

Tooltip type

Control category

Example types

AFX_TOOLTIP_TYPE_BUTTON

A button.

CMFCButton

AFX_TOOLTIP_TYPE_CAPTIONBAR

A caption bar.

CMFCCaptionBar

AFX_TOOLTIP_TYPE_DEFAULT

Any control that does not fit another category.

None.

AFX_TOOLTIP_TYPE_DOCKBAR

A dockable pane.

CDockablePane

AFX_TOOLTIP_TYPE_EDIT

A text box.

None.

AFX_TOOLTIP_TYPE_MINIFRAME

A miniframe.

CPaneFrameWnd

AFX_TOOLTIP_TYPE_PLANNER

A planner.

None.

AFX_TOOLTIP_TYPE_RIBBON

A ribbon bar.

CMFCRibbonBar, CMFCRibbonPanelMenuBar

AFX_TOOLTIP_TYPE_TAB

A tab control.

CMFCTabCtrl

AFX_TOOLTIP_TYPE_TOOLBAR

A toolbar.

CMFCToolBar, CMFCPopupMenuBar

AFX_TOOLTIP_TYPE_TOOLBOX

A toolbox.

None.

Requirements

Header: afxtooltipmanager.h

See Also

Reference

CTooltipManager Class

CMFCToolTipCtrl Class

Hierarchy Chart