Share via


TreeView_Select (Compact 2013)

3/28/2014

This macro selects the specified tree-view item, scrolls the item into the view, or redraws the item in the style used to indicate the target of a drag-and-drop operation. You can use this macro or the TreeView_SelectItem, TreeView_SelectSetFirstVisible, or TreeView_SelectDropTarget macro, or you can send the TVM_SELECTITEM message explicitly.

Syntax

BOOL TreeView_Select( 
    hwnd, 
    hitem, 
    flag 
);

Parameters

  • hwnd
    Handle to the tree view control.
  • hitem
    Handle to an item. If the hitem parameter is NULL, the control is set to have no selected item.
  • flag
    Action flag. It is one of the following values.

    Value

    Description

    TVGN_CARET

    Sets the selection to the item. The control's parent window receives the TVN_SELCHANGING and TVN_SELCHANGED messages.

    TVGN_DROPHILITE

    Redraws the item in the style used to indicate the target of a drag-and-drop operation.

    TVGN_FIRSTVISIBLE

    Ensures that the specified item is visible, and, if possible, displays it at the top of the control's window. 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.

Return Value

TRUE indicates success. FALSE indicates failure.

Remarks

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 messages.

Requirements

Header

commctrl.h

See Also

Reference

Tree View Controls Macros
TreeView_SelectDropTarget
TreeView_SelectItem
TreeView_SelectSetFirstVisible
TVM_SELECTITEM
TVN_ITEMEXPANDED
TVN_ITEMEXPANDING
TVN_SELCHANGED
TVN_SELCHANGING