TcxCustomEditorRowProperties.OnGetFilterImages Event

Allows you to replace images displayed in an edit row’s filter pop-up window.

Declaration

property OnGetFilterImages: TcxGetFilterImagesEvent read; write;

Remarks

An edit row’s filter pop-up window automatically displays images for filter items if the row uses a TcxImageComboBox instance as an in-place editor. The filter pop-up window retrieves filter item images from the image list assigned to the editor’s Properties.Images property:

Handle the OnGetFilterImages event to replace automatically displayed filter item images or display images for filter items if the editor row does not use an Image Combo Box as an in-place editor. Additionally, you can rearrange displayed images or hide them for specific filter items. If you need to hide automatically displayed filter item images, assign nil (in Delphi) or nullptr (in C++Builder) to the AImages parameter within an OnGetFilterImages event handler:

Delphi

procedure TMyForm.vgOrdersPaymentTypeGetFilterImages(
  Sender: TObject; AValueList: TcxFilterValueList;
  var AImages: TCustomImageList);
begin
  AImages := nil;
end;

C++

void __fastcall TMyForm::vgOrdersPaymentGetFilterImages(
  TObject *Sender, TcxFilterValueList *AValueList,
  TCustomImageList *AImages)
{
  AImages = nullptr;
}

Refer to the TcxGetFilterImagesEvent procedural type description for an additional code example and detailed information on parameters accessible within an OnGetFilterImages event handler.