Click or drag to resize

TreeView.Collapse Method (Symbol, Logic, Logic, Logic)

X#
Collapse a tree view item, hiding its child items.

Namespace:  XSharp.VO.SDK
Assembly:  XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.19
Syntax
 VIRTUAL METHOD Collapse(
	symName AS SYMBOL,
	lRemoveChildItems AS LOGIC,
	lAll AS LOGIC,
	lForceNotify AS LOGIC
) AS USUAL
Request Example View Source

Parameters

symName
Type: Symbol
The symbolic name of the tree view item to be collapsed.
lRemoveChildItems
Type: Logic
A logical value indicating whether child tree view items of the specified item will be removed when the item is collapsed. If omitted, the default is FALSE.
lAll
Type: Logic
If lAll is TRUE(default = FALSE), the operation is done for the complete subtree of the specified item.
lForceNotify
Type: Logic
If lForceNotify is TRUE(default = FALSE), a notify message Window:TreeViewItemExpanding() and Window:TreeViewItemExpanded() is sent for each item whose expand state is changed. Generally windows will only send these messages when an item is first expanded. It depends on the TVIS_EXPANDEDONCE state. (see in Platform SDK the TVM_EXPAND Message for more details.)

Return Value

Type: Usual
TRUE if successful; otherwise, FALSE.
See Also