TreeView_SelectSetFirstVisible macro (commctrl.h)

Article
10/23/2024

Scrolls the tree-view control vertically to ensure that the specified item is visible. If possible, the specified item becomes the first visible item at the top of the control's window. You can use this macro or the TreeView_Select macro, or you can send the TVM_SELECTITEM message explicitly.

Syntax

BOOL TreeView_SelectSetFirstVisible(
   HWND      hwnd,
   HTREEITEM hitem
);

Parameters

hwnd

Type: HWND

Handle to the tree-view control.

hitem

Type: HTREEITEM

Handle to an item. If the hitem parameter is NULL, the control is set to have no selected item.

Return value

Type: BOOL

Returns TRUE if successful, or FALSE otherwise.

Remarks

Tree-view controls display as many items as will fit in the window. If the specified item is near the bottom of the control's hierarchy of items, it might not become the first visible item, depending on how many items fit in the window.

If the specified item is the child of a collapsed parent item, the parent's list of child items is expanded to reveal the specified item. In this case, the parent window receives the TVN_ITEMEXPANDING and TVN_ITEMEXPANDED notification codes.

Using the TreeView_SelectSetFirstVisible macro is equivalent to sending the TVM_SELECTITEM message with its flag parameter set to the TVGN_FIRSTVISIBLE value.

Requirements

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

Share via