TreeView_GetItemPartRect macro (commctrl.h)

Article
10/23/2024

Retrieves the largest possible bounding rectangle that constitutes the "hit zone" for a specified part of an item. Use this macro or send the TVM_GETITEMPARTRECT message explicitly.

Syntax

BOOL TreeView_GetItemPartRect(
   HWND       hwnd,
   HTREEITEM  hitem,
   RECT       *prc,
   TVITEMPART *partid
);

Parameters

hwnd

Type: HWND

Handle to the tree-view control.

hitem

Type: HTREEITEM

Handle to the tree-view item.

prc

Type: RECT*

Pointer to a RECT structure that receives the bounding rectangle. The caller is responsible for allocating this structure. The coordinates received are relative to the upper-left corner of the tree-view control.

partid

Type: TVITEMPART*

ID of the item part. This value must be TVGIPR_BUTTON (0x0001).

Return value

Type: BOOL

Returns TRUE if successful, or FALSE otherwise.

Remarks

This message returns the largest possible bounding rectangle such that for every (x,y) coordinate within the rectangle, a click by the user at that coordinate would constitute a hit on that part of the item.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	commctrl.h

Share via