Navigation:  Classes > bCellGroupItem >

bCellGroupItem:IsCellInside()

Print this Topic    Previous pageReturn to chapter overviewNext page

Purpose

Check whether the cell is inside the area of the cell group.

Class

bCellGroupItem

Type

Method

Syntax

<oCellGroupItem>:IsCellInside(

<oCell>,

<iOptions>

) Æ iState

Arguments

<oCell>The cell for which is checked, whether it is located in the area of the cell group.
Data Type:bCell

 

<iOptions>Options which should be considered in the examination. The options below are supported:

 

Option

Description

BCGIICIO_NONE

No options are taken into account.

BCGIICIO_ABSOLUTEPOSITION

The start cell and end cell of the cell group are converted to absolute positions.

BCGIICIO_IGNOREPERCENTAGE

The percentage quotas of the passed cell as well as the start cell and end cell of the cell group are not taken into account.

BCGIICIO_RELATIVEPOSITION

The start cell and end cell of the cell group are converted to relative positions related to the parent cell group.

 

Data Type:DWord

Return Value

iStateA numeric value which defines, whether the cell is located in the area of the cell group. The values below are supported:

 

Value

Description

BCGIICI_INSIDE

The cell is completely located in the area of the cell group.

BCGIICI_BEFORE

The cell is in front of the area of the cell group.

BCGIICI_BEHIND

The cell is behind the area of the cell group.

BCGIICI_INTERSECT

The cell is partly located in the area of the cell group.

 

Data Type:Integer

Description

bCellGroupItem:IsCellInside() checks whether the passed cell is inside the area of the cell group.

See Also

bCellGroupList:GetFromCell()

bCellGroupItem:IsChildFrom()

bCellGroupItem:IsParentFrom()

 


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