CMFCRibbonBar::HitTest

Retrieves a pointer to the ribbon element specified by the location of the point.

virtual CMFCRibbonBaseElement* HitTest(
   CPoint point,
   BOOL bCheckActiveCategory = FALSE,
   BOOL bCheckPanelCaption = FALSE 
);

Parameters

• [in] point
  Location of the point in ribbon bar coordinates.

• [in] bCheckActiveCategory
  TRUE to search the active category; FALSE not to search the active category.

• [in] bCheckPanelCaption
  TRUE to test the caption of the ribbon panel with the point located in it; FALSE not to test the caption of the ribbon panel with the point located in it. See the Remarks section for more information.

Return Value

A pointer to the ribbon element located at the specified point; otherwise NULL if the point is not located in a ribbon element.

Remarks

The caption of the ribbon panel with the point located in it is not tested unless the bCheckActiveCategory parameter is TRUE.

Requirements

Header: afxribbonbar.h

See Also

Concepts

MFC Hierarchy Chart

Reference

CMFCRibbonBar Class

Change History