TdxPopulateCustomScrollbarAnnotationRowIndexList Type

The custom scrollbar annotation display event type.

Declaration

TdxPopulateCustomScrollbarAnnotationRowIndexList = procedure(Sender: TObject; AAnnotationIndex: Integer; ARowIndexList: TdxScrollbarAnnotationRowIndexList) of object;

Parameters

Name	Type
Sender	TObject
AAnnotationIndex	Integer
ARowIndexList	TdxScrollbarAnnotationRowIndexList

Remarks

The Sender parameter provides access to the container control (a TcxEditingControl class descendant) that raised a TdxPopulateCustomScrollbarAnnotationRowIndexList event. Cast the Sender parameter value to the corresponding container control class (TcxDBVerticalGrid or TcxTreeList, for instance) to access its members.

Use the AAnnotationIndex parameter to identify a custom annotation whose marks the container control is about to display on its scrollbar. Different annotations should have different scrollbar mark display criteria.

The ARowIndexList parameter defines the list of records marked with the custom annotation whose index is AAnnotationIndex. Call the ARowIndexList.Add procedure to add a custom scrollbar annotation mark to the record that meets any required criteria.

A container control’s OnPopulateCustomScrollbarAnnotationRowIndexList event references the TdxPopulateCustomScrollbarAnnotationRowIndexList type. Refer to this event description for additional information and a code example.