CollapseAllChildren method (DataWindows)
Description
Collapses a group in a TreeView DataWindow that has the specified TreeView
level and includes the specified row; also collapses all the group’s
children.
Controls
DataWindow type |
Method applies to |
---|---|
PowerBuilder |
DataWindow control |
Syntax
[PowerBuilder]
1 |
Integer <span>dw_control</span>.<span>ExpandAllChildren</span>(long <span>row</span>, long <span>groupLevel</span>) |
Argument |
Description |
---|---|
dw_control |
A reference to a TreeView-style DataWindow |
row |
The number of the row that belongs to |
groupLevel |
The TreeView level of the group to be |
Return Values
Returns 1 if the expand operation succeeds and one of the
following negative values if it fails:
-
-1
DataWindow is null
-
-5
One or more of the parameters are invalid
-
-16
DataWindow is not a TreeView DataWindow
Usage
A TreeView DataWindow has several TreeView level bands (groups)
that can be expanded and collapsed. You can use the CollapseAllChildren method
to collapse a group with a specified TreeView level in a TreeView DataWindow
and all of its children.
The CollapseAllChildren method triggers
the Collapsing and Collapsed events.
Examples
The following example collapses the group in a TreeView
DataWindow that has TreeView level 2 and includes row 3 and all
the group’s children:
1 |
integer li_ret<br>li_ret = dw_treeview.<span>CollapseAllChildren</span>(3,2) |