Navigation:  Classes > bCellGroupList >

bCellGroupList:Add()

Print this Topic    Previous pageReturn to chapter overviewNext page

Purpose

Add a new cell group to the end of the list.

Class

bCellGroupList

Type

Method

Syntax

<oCellGroupList>:Add(<oCellGroupItem>) Æ lSuccess

Arguments

<oCellGroupItem>The cell group, which be added to the list.
Data Type:bCellGroupItem

Return Value

lSuccessA logical value that indicates whether the cell group was added to the list.
TRUEThe cell group was added.
FALSEThe cell group could not be added.
Data Type:Logic

Description

bCellGroupList:Add() adds a new cell group to the list. If the value BCGLO_ROWCONTROL is defined in the bCellGroupList:Options then the cell group is sorted in ascending order in the list based on the bCellGroupItem:StartCell. Otherwise the cell group is added at the end of the list. The owner of the list is put as parent of the cell group. Furthermore the start and end cell of the cell group is transformed in relative values. The transformation is executed only if the option BCGIO_ABSOLUTEPOSITION is not defined in the access bCellGroupItem:Options.

 

The method does not examine whether the cell group already exists in the list. If it is to be avoided that an cell group is added to the list several times, this must be examined before by the method bCellGroupList:Exist().

See Also

bCellGroupItem:Options

bCellGroupItem:Parent

bCellGroupList:Delete()

bCellGroupList:Exist()

bCellGroupList:Options

bCellGroupList:Put()

 


Page url: http://www.YOURSERVER.com/index.html?bcellgrouplist_add.htm