TreeView_EditLabel macro (commctrl.h)

Article
10/23/2024

Begins in-place editing of the specified item's text, replacing the text of the item with a single-line edit control containing the text. This macro implicitly selects and focuses the specified item. You can use this macro or send the TVM_EDITLABEL message explicitly.

Syntax

HWND TreeView_EditLabel(
   HWND      hwnd,
   HTREEITEM hitem
);

Parameters

hwnd

Type: HWND

Handle to the tree-view control.

hitem

Type: HTREEITEM

Handle to the item to edit.

Return value

Type: HWND

Returns the handle to the edit control used to edit the item text if successful, or NULL otherwise.

Remarks

This macro sends a TVN_BEGINLABELEDIT notification code to the parent of the tree-view control.

When the user completes or cancels editing, the edit control is destroyed and the handle is no longer valid. You can subclass the edit control, but do not destroy it.

The control must have the focus before you call this macro. Focus can be set using the SetFocus function.

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