CollapseLevel

Description

Collapses all the groups in a TreeView DataWindow that have the specified TreeView level.

Applies to

DataWindow type

Method applies to

PowerBuilder

DataWindow control


Syntax

PowerBuilder

Integer dw_control.CollapseLevel (long groupLevel)

Argument

Description

dw_control

A reference to a TreeView-style DataWindow control

groupLevel

The TreeView level of the group to be collapsed


Return value

Returns 1 if the CollapseLevel 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 CollapseLevel method to collapse all the groups in a TreeView DataWindow that have a particular TreeView level.

The CollapseLevel method triggers the Collapsing and Collapsed events with a row argument of -1.

Examples

The following example collapses TreeView level 2:

integer li_ret
li_ret = dw_treeview.CollapseLevel(2)

See also

Collapse

CollapseAll

CollapseAllChildren

ExpandLevel