Skip to main content

TcxPivotGridGroupItem.Compare(Variant) Method

Compares the Value and the AValue.

Declaration

function Compare(const AValue: Variant): Integer; overload;

Parameters

Name Type
AValue Variant

Returns

Type
Integer

Remarks

When called, the Compare method fires the TcxCustomPivotGrid.OnCompare event allowing developers to provide another comparison algorithm (if required). If the event handler is not implemented, then the default comparison is performed. By default, the Compare method is used for sorting the field values in ascending order.

Depending upon the result of collation, the Compare method returns one of the following values:

Value Description
1 Value is greater than AValue
0 Value and AValue are equal
-1 Value is less than AValue

Note

The Compare method is called only in standard data binding modes. In OLAP mode, field values are sorted as specified by the dimension SortMode property settings.

See Also