bRecordGroup:CollapseItems()

Purpose

Collapse one or all expanded record group items.

Class

bRecordGroup

Type

Method

Syntax

<oRecordGroup>:CollapseItems(

<iOptions>,

[<auItem>]

) Æ lSuccess

Arguments

The options that are to be used when collapsing the record group items. The following values are supported:

Option	Description
BRGCIO_NONE	No options are defined.
BRGCIO_CLEARAUTOOPENINLEVEL	In combination with the option BRGCIO_COLLAPSEALL the option BRGLO_AUTOOPEN is cleared in the record group level of all closed record group items (see also bRecordGroupItem:Level).
BRGCIO_COLLAPSEALL	Collapse all record group items which are already determined. Remarks So that the record group items are also collapsed automatically which were not determined yet, the option BRGCIO_CLEARAUTOOPENINLEVEL must be defined in addition. The Argument auItem is not to be used.
BRGCIO_ITEM	The argument auItem contains objects of the class bRecordGroupItem. Remarks The option is not supported in combination with BRGCIO_COLLAPSEALL or BRGCIO_CLEARAUTOOPENINLEVEL.
BRGCIO_RECNO	The argument auItem contains the record numbers of the record group items.
BRGCIO_REGARDSUBITEMS	If a record group item contains sub items, then these are also collapsed.

Data Type:

DWord

List of the record group items which are to be collapsed. The list can contain either objects of the class bRecordGroupItem or the record numbers of the record group items.

Data Type:

Array

Return Value

lSuccess

A logical value that indicates whether the record group items could be collapsed.

TRUE	The record group items were collapsed.

FALSE

The record group items could not be collapsed.

Data Type:

Logic

Description

bRecordGroup:CollapseItems() collapse one or all open record group items.

Samples

In the sample below all expanded record group items in a bBrowser are collapsed.

// Collapse all already expanded record group items
oBrowser:RecordGroup:CollapseItems(_Or(BRGCIO_COLLAPSEALL, BRGCIO_CLEARAUTOOPENINLEVEL))

// Refresh the bBrowser

oBrowser:Refresh()