Purpose
Compares the start cell or end cell of the cell group with the passed cell.
Class
Type
Method
Syntax
<oCellGroupItem>:CompareCell(
<oCell>,
<iOptions>
) Æ lSuccess
Arguments
<oCell> | The cell, whose values should be compared. |
Data Type: | bCell |
<iOptions> | Options which should to be considered. The options below are supported: |
Option |
Description |
BCGICCO_ABSOLUTEPOSITION |
The passed cell contains absolute values. For the comparison the values of the cell are converted to absolute values if necessary (see also bCellGroupItem:Options). |
BCGICCO_COMPAREENDCELL |
The passed cell is compared with the end cell of the cell group. |
BCGICCO_COMPARESTARTCELL |
The passed cell is compared with the start cell of the cell group. |
BCGICCO_IGNOREPERCENTAGE |
|
BCGICCO_RELATIVEPOSITION |
The passed cell contains relative values related to the parent cell group. For the comparison the values of the cell are converted to relative values if necessary (see also bCellGroupItem:Options). |
Data Type: | DWord |
Return Value
iResult | A numerical value that defines whether the passed cell is equal or before or behind the cell of the cell group. If both cells are equal, then the value BCCR_EQUAL will be returned. Otherwise the Lo-Word contains the result for the column value and the Hi-Word the result for the row value. The following values may be returned: |
Value |
Description |
BCCR_BEFORE |
The column value or row value of the passed cell is before the cell of the cell group. |
BCCR_EQUAL |
The column value or row value of the passed cell is equal to the cell of the cell group. |
BCCR_BEHIND |
The column value or row value of the passed cell is behind the cell of the cell group. |
Data Type: | DWord |
Description
bCellGroupItem:CompareCell() compares the column and the row of the passed cell with the start cell or end cell of the cell group. For the comparison the method bCell:Compare() is invoked internally.
See Also
Page url: http://www.YOURSERVER.com/index.html?bcellgroupitem_comparecell.htm