Collapses a parent item.

C

BOOL WINAPI SftTree_Collapse(HWND hwndCtl, int index, BOOL fPreserve);
BOOL WINAPI SftTreeSplit_Collapse(HWND hwndCtl, int index, BOOL fPreserve);

C++

BOOL CSftTree::Collapse(int index, BOOL fPreserve = TRUE);
BOOL CSftTreeSplit::Collapse(int index, BOOL fPreserve = TRUE);

Parameters

hwndCtl

The window handle of the tree control.

index

The zero-based index of the item to be collapsed.  If -1 is specified, all items on level 0 are collapsed.

fPreserve

Set to TRUE to preserve the expand/collapse state of dependent items made no longer visible.  A subsequent call to Expand will restore the items with the remembered expand/collapse state.  If FALSE is specified, the expand/collapse state is not preserved.

Returns

The return value is TRUE if successful, otherwise FALSE is returned.

Comments

The Collapse function collapses a parent item.

Collapse collapses the specified parent item index, hides all dependent items and saves the expand/collapse state of all dependent items (if fPreserve is set to TRUE), so it can be restored by a subsequent call to Expand.

In a tree control using a virtual data source, this function cannot be used.

See Also  C/C++ API  |  Categories |  Notifications