TcxCustomDataController.FilteredIndexByRecordIndex Property

Returns the position of a data record in the list of filtered records.

Declaration

property FilteredIndexByRecordIndex[Index: Integer]: Integer read;

Property Value

Type
Integer

Remarks

The FilteredIndexByRecordIndex property returns the position of a record in the list of filtered records. The record required is identified by its index via the Index parameter.

The value returned is the index of a record within the list of filtered records. It can vary from 0 to FilteredRecordCount - 1. If a specific record doesn’t belong to the list of filtered records (it doesn’t meet the filter criteria set), the FilteredIndexByRecordIndex returns -1.

The following code tests whether a particular record in a data controller meets the current filter criteria.

Delphi

function IsFiltered(ADataController: TcxCustomDataController; ARecordIndex: Integer): Boolean;
begin
  Result := ADataController.FilteredIndexByRecordIndex[ARecordIndex] <> -1;
end;

C++

bool IsFiltered(TcxCustomDataController * ADataController, int ARecordIndex) {
  return ADataController->FilteredIndexByRecordIndex[ARecordIndex] != -1;
}