Tree View Controls Macros (Compact 2013)

3/28/2014

The following table shows the tree view controls macros, with a description of the purpose of each.

Programming element

Description

TreeView_CreateDragImage

This macro creates a dragging bitmap for the specified item in a tree-view control, creates an image list for the bitmap, and adds the bitmap to the image list.

TreeView_DeleteAllItems

This macro removes an item from a tree-view control.

TreeView_DeleteItem

This macro removes an item from a tree-view control.

TreeView_EditLabel

This macro begins in-place editing of the text of the specified item, replacing the text of the item with a single-line edit control containing the text.

TreeView_EndEditLabelNow

This macro ends the editing of a label for a tree-view item.

TreeView_EnsureVisible

This macro ensures that a tree-view item is visible, expanding the parent item or scrolling the tree-view control, if necessary.

TreeView_Expand

This macro expands or collapses the list of child items, if any, associated with the specified parent item.

TreeView_GetChild

This macro retrieves the first child item of the specified tree-view item.

TreeView_GetCount

This macro retrieves a count of the items in a tree-view control.

TreeView_GetDropHilight

This macro retrieves the tree-view item that is the target of a drag-and-drop operation.

TreeView_GetEditControl

This macro retrieves the handle to the edit control being used to edit the text for a tree-view item.

TreeView_GetFirstVisible

This macro retrieves the first visible item in a tree-view control window.

TreeView_GetImageList

This macro retrieves the handle to the normal or state image list associated with a tree-view control.

TreeView_GetIndent

This macro retrieves the amount, in pixels, that child items are indented relative to their parent items.

TreeView_GetISearchString

This macro retrieves the incremental search string for a tree-view control.

TreeView_GetItem

This macro retrieves some or all of the attributes of a tree-view item.

TreeView_GetItemRect

This macro retrieves the bounding rectangle for a tree-view item and indicates whether the item is visible.

TreeView_GetNextItem

This macro retrieves the tree-view item that bears the specified relationship to a specified item.

TreeView_GetNextSibling

This macro retrieves the next sibling item of a specified item in a tree-view control.

TreeView_GetNextVisible

This macro retrieves the next visible item that follows a specified item in a tree-view control.

TreeView_GetParent

This macro retrieves the parent item of the specified tree-view item.

TreeView_GetPrevSibling

This macro retrieves the previous sibling item of a specified item in a tree-view control.

TreeView_GetPrevVisible

This macro retrieves the first visible item that precedes a specified item in a tree-view control.

TreeView_GetRoot

This macro retrieves the topmost or very first item of the tree-view control.

TreeView_GetSelection

This macro retrieves the currently selected item in a tree-view control.

TreeView_GetVisibleCount

This macro obtains the number of items that can be fully visible in the client window of a tree-view control.

TreeView_HitTest

This macro determines the location of the specified point relative to the client area of a tree-view control.

TreeView_InsertItem

This macro inserts a new item in a tree-view control.

TreeView_Select

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.

TreeView_SelectDropTarget

This macro redraws a specified tree-view control item in the style used to indicate the target of a drag-and-drop operation.

TreeView_SelectItem

This macro selects the specified tree-view item.

TreeView_SelectSetFirstVisible

This macro scrolls the tree-view control vertically to ensure that the specified item is visible.

TreeView_SetImageList

This macro sets the normal or state image list for a tree-view control and redraws the control using the new images.

TreeView_SetIndent

This macro sets the width of indentation for a tree-view control and redraws the control to reflect the new width.

TreeView_SetItem

This macro sets some or all of the attributes of a tree-view item.

TreeView_SortChildren

This macro sorts the child items of the specified parent item in a tree-view control.

TreeView_SortChildrenCB

This macro sorts tree-view items using an application-defined callback function that compares the items.

See Also

Reference

Tree View Controls Reference